Ability to disable entrypoint and /api/docs #1580

athos7933 · 2017-12-20T13:38:27Z

Q	A
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	#1568
License	MIT
Doc PR	api-platform/docs#365

dunglas

It currently doesn't disable the entrypoint. The route for the entrypoint is defined here:

core/src/Bridge/Symfony/Bundle/Resources/config/routing/api.xml

Line 8 in f62ab14

dunglas · 2017-12-20T13:43:12Z

src/Bridge/Symfony/Bundle/DependencyInjection/Configuration.php

@@ -87,6 +87,7 @@ public function getConfigTreeBuilder()
                ->end()
                ->booleanNode('enable_swagger')->defaultValue(true)->info('Enable the Swagger documentation and export.')->end()
                ->booleanNode('enable_swagger_ui')->defaultValue(class_exists(TwigBundle::class))->info('Enable Swagger ui.')->end()
+                ->booleanNode('enable_entrypoint')->defaultTrue()->info('Enable/disable the entry-point')->end()


Enable the entrypoint for the shake of consistency

I would also create a separate flag for entrypoint and docs, (you may want the docs, but not the entrypoint for instance).

dunglas · 2017-12-20T13:43:39Z

src/Bridge/Symfony/Bundle/Resources/config/routing/doc.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8" ?>


Should be docs.xml.

athos7933 · 2017-12-20T15:07:36Z

I dont't know why some behat failed ! My changes do not impact the tests.
@dunglas I did the changes.

soyuka · 2017-12-20T15:43:05Z

We need to merge 2.1, it's because of #1578

Nek- · 2017-12-21T09:16:16Z

@athos7933 you need to rebase your work on master :)

soyuka · 2017-12-21T11:31:39Z

Just merged 2.1, please rebase onn master :)

athos7933 · 2017-12-21T11:37:11Z

@soyuka Yes, i'ts already done

Nek- · 2017-12-22T23:54:51Z

@athos7933 I don't know what you did wrong but what you did is not a rebase but a merge.

meyerbaptiste · 2017-12-24T08:00:22Z

src/Bridge/Symfony/Routing/ApiLoader.php

@@ -146,6 +146,14 @@ private function loadExternalFiles(RouteCollection $routeCollection)
    {
        $routeCollection->addCollection($this->fileLoader->load('api.xml'));

+        if ($this->container->getParameter('api_platform.enable_entrypoint')) {


Should not we inject these parameters in the constructor instead?

The constructor is already really huge. Also the container is already use at many places. This seems ok.

Another option is to use… options, along with the option resolver. $graphqlEnabled should go in there.

@greg0ire it's adding a dependency. Which is not awesome.

You can use a simple array, that's possible too

athos7933 · 2017-12-29T10:26:54Z

@dunglas I did the change you want.

Nek- · 2018-01-08T13:49:50Z

Failure is not related to this patch, it's about Symfony4 and this new line of code: https://github.com/symfony/symfony/blame/master/src/Symfony/Component/HttpFoundation/Request.php#L1855

cc @vincentchalamon

vincentchalamon · 2018-01-08T14:19:23Z

Hello @Nek- @athos7933, unit tests will be fixed in this PR: #1631

athos7933 · 2018-01-10T14:34:52Z

@dunglas Hi ! Waiting for review.

dunglas · 2018-01-10T15:31:57Z

Thanks you very much @athos7933! Don't forget to open a docs PR against the master branch please :)

Taluu · 2018-02-07T10:33:48Z

src/Bridge/Symfony/Routing/ApiLoader.php

@@ -146,6 +150,14 @@ private function loadExternalFiles(RouteCollection $routeCollection)
    {
        $routeCollection->addCollection($this->fileLoader->load('api.xml'));

+        if ($this->entrypointEnabled) {
+            $routeCollection->addCollection($this->fileLoader->load('api.xml'));
+        }


doesn't this add 2 times the api.xml file ? :o

(looking at the line above)

…o-disable-entrypoint Ability to disable entrypoint and /api/docs

dunglas requested changes Dec 20, 2017

View reviewed changes

athos7933 force-pushed the feature/ability-to-disable-entrypoint branch from 7583dfc to 2e30b6f Compare December 20, 2017 14:01

athos7933 force-pushed the feature/ability-to-disable-entrypoint branch from 2e30b6f to 25b27f1 Compare December 21, 2017 10:19

soyuka approved these changes Dec 21, 2017

View reviewed changes

meyerbaptiste reviewed Dec 24, 2017

View reviewed changes

athos7933 force-pushed the feature/ability-to-disable-entrypoint branch 3 times, most recently from 80959ad to 2b059e8 Compare December 29, 2017 10:24

athos7933 force-pushed the feature/ability-to-disable-entrypoint branch 2 times, most recently from db1504a to 6fb92ca Compare January 8, 2018 09:30

athos7933 changed the title ~~Ability to disable entrypoint /api/docs~~ Ability to disable entrypoint and /api/docs Jan 8, 2018

athos7933 force-pushed the feature/ability-to-disable-entrypoint branch 2 times, most recently from 8171c0c to 75ec721 Compare January 8, 2018 09:53

vincentchalamon mentioned this pull request Jan 8, 2018

Fix unit tests #1631

Closed

athos7933 force-pushed the feature/ability-to-disable-entrypoint branch 2 times, most recently from e824a56 to f77ae7c Compare January 9, 2018 11:13

Ability to disable entrypoint and /api/docs

7181269

athos7933 force-pushed the feature/ability-to-disable-entrypoint branch from f77ae7c to 7181269 Compare January 10, 2018 08:02

soyuka approved these changes Jan 10, 2018

View reviewed changes

dunglas approved these changes Jan 10, 2018

View reviewed changes

dunglas merged commit 4ea214d into api-platform:master Jan 10, 2018

athos7933 deleted the feature/ability-to-disable-entrypoint branch January 16, 2018 12:53

Taluu reviewed Feb 7, 2018

View reviewed changes

soyuka pushed a commit to soyuka/core that referenced this pull request Feb 7, 2018

Don't load api.xml twice (see api-platform#1580 (comment))

68ae392

soyuka mentioned this pull request Feb 7, 2018

Don't load api.xml twice (see https://github.com/api-platform/core/pu… #1682

Merged

hoangnd25 pushed a commit to hoangnd25/core that referenced this pull request Feb 23, 2018

Merge pull request api-platform#1580 from athos7933/feature/ability-t…

6104775

…o-disable-entrypoint Ability to disable entrypoint and /api/docs

hoangnd25 pushed a commit to hoangnd25/core that referenced this pull request Feb 23, 2018

Don't load api.xml twice (see api-platform#1580 (comment))

c8a1a3f

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ability to disable entrypoint and /api/docs #1580

Ability to disable entrypoint and /api/docs #1580

athos7933 commented Dec 20, 2017

dunglas left a comment

dunglas Dec 20, 2017

dunglas Dec 20, 2017

dunglas Dec 20, 2017 •

edited

Loading

athos7933 commented Dec 20, 2017 •

edited

Loading

soyuka commented Dec 20, 2017

Nek- commented Dec 21, 2017

soyuka commented Dec 21, 2017 •

edited

Loading

athos7933 commented Dec 21, 2017

Nek- commented Dec 22, 2017

meyerbaptiste Dec 24, 2017

Nek- Dec 25, 2017

greg0ire Jan 8, 2018 •

edited

Loading

Nek- Jan 8, 2018 •

edited

Loading

greg0ire Jan 8, 2018

athos7933 commented Dec 29, 2017

Nek- commented Jan 8, 2018 •

edited

Loading

vincentchalamon commented Jan 8, 2018

athos7933 commented Jan 10, 2018

dunglas commented Jan 10, 2018

Taluu Feb 7, 2018

Taluu Feb 7, 2018

soyuka Feb 7, 2018

Ability to disable entrypoint and /api/docs #1580

Ability to disable entrypoint and /api/docs #1580

Conversation

athos7933 commented Dec 20, 2017

dunglas left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dunglas Dec 20, 2017 • edited Loading

Choose a reason for hiding this comment

athos7933 commented Dec 20, 2017 • edited Loading

soyuka commented Dec 20, 2017

Nek- commented Dec 21, 2017

soyuka commented Dec 21, 2017 • edited Loading

athos7933 commented Dec 21, 2017

Nek- commented Dec 22, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

greg0ire Jan 8, 2018 • edited Loading

Choose a reason for hiding this comment

Nek- Jan 8, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

athos7933 commented Dec 29, 2017

Nek- commented Jan 8, 2018 • edited Loading

vincentchalamon commented Jan 8, 2018

athos7933 commented Jan 10, 2018

dunglas commented Jan 10, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dunglas Dec 20, 2017 •

edited

Loading

athos7933 commented Dec 20, 2017 •

edited

Loading

soyuka commented Dec 21, 2017 •

edited

Loading

greg0ire Jan 8, 2018 •

edited

Loading

Nek- Jan 8, 2018 •

edited

Loading

Nek- commented Jan 8, 2018 •

edited

Loading