Unable to retrieve API documentation.

[TangMonk]

I am using the latest Symfony 4, api-platform bundle, and following the documentation to setup api and admin

the api works(screenshot):

the admin(screenshot):

And I disable the cors in chrome, but still not work

And I try to remove react and react-dom in package.json and yarn install agin, it still not work

[mamoot64]

Hi,

Do you have "Nelmio CORS Bundle" installed ?

If not, you must to add it :

composer require "nelmio/cors-bundle:@dev"

It seems that add directly require bundle without @dev tag give compatbilities errors.
SF4 recipe is not now available.

Add bundle configuration inside "config/package/nelmio_cors.yaml" :

    nelmio_cors:
        defaults:
            allow_credentials: false
            allow_origin: []
            allow_headers: []
            allow_methods: []
            expose_headers: []
            max_age: 0
            hosts: []
            origin_regex: false
            forced_allow_origin_value: ~
        paths:
            '^/api/':
                allow_origin: ['*']
                allow_headers: ['X-Custom-Auth']
                allow_methods: ['POST', 'PUT', 'GET', 'DELETE']
                max_age: 3600
            '^/':
                origin_regex: true
                allow_origin: ['^http://localhost:[0-9]+']
                allow_headers: ['X-Custom-Auth']
                allow_methods: ['POST', 'PUT', 'GET', 'DELETE']
                max_age: 3600
                hosts: ['^api\.']

After that, you can trick your Nelmio CORS configuration.

Nicolas

[jorenvh1]

I have the same issue and I have Nelmio Cors enabled.
It's unclear for me which URL to use for the entrypoint in my react app...

Could you please explain if you have to enable any other settings (both on the api or the frontend) to make this work? @acidline

[vincentchalamon]

@TangMonk @jorenvh1 could you dump your App.js content please?

[jorenvh1]

@vincentchalamon

import { HydraAdmin } from '@api-platform/admin';

export default class App extends Component {
  render() {
    return (
        <HydraAdmin entrypoint="http://symfony-3.dev"/>
    );
  }
}

[vincentchalamon]

@jorenvh1 I guess http://symfony-3.dev is your local API entrypoint, and you have nelmio/cors correctly configured? You can use * as nelmio_cors.default.allow_origin

[jorenvh1]

@vincentchalamon Yeah, exactly, also cors are set up properly I think. When I look in my network tab, 2 calls are made.

First an OPTIONS call to that url, then a GET call to the same url. The GET call returns my /books endpoint but the frontend just shows me the text: 'Unable to retrieve API documentation'

[vincentchalamon]

Weird that your front can successfully call the API, but blocks on this error. Is the last GET call successful in your Networks tab? Could you also try with a curl http://symfony-3.dev/books?

[jorenvh1]

Yep, last GET call is successful and returns my entrypoint for books.

[jorenvh1]

@vincentchalamon This is a screenshot of my network tab (I changed the domain to api-platform-api.dev)

[andreluizlunelli]

Hi, first of all, awesome project!

Get the same error.

localhost/:1 Failed to load http://localhost:8080/: Response to preflight request doesn't pass access control check: The 'Access-Control-Allow-Origin' header contains the invalid value 'null'. Origin 'http://localhost:3000' is therefore not allowed access. Have the server send the header with a valid value, or, if an opaque response serves your needs, set the request's mode to 'no-cors' to fetch the resource with CORS disabled.

Running project with configs:

• php 7.1
• Symfony 3.3.13
• parameters.yml with cors_allow_origin: '*'
• App.js with entrypoint http://localhost:8080

http://localhost:8080/ run api properly

I'm newbie in Symfony =/

Can someone help me?

[andreluizlunelli]

Hi,

I add a add_header 'Access-Control-Allow-Origin' '*'; on default.conf file, build docker image, run and works!

[jorenvh1]

Hey @andreluizlunelli The cors headers are set to '*' for me as well, just as a test. The api call actually works so I'm still uncertain as to why it still gives me the error...

[andreluizlunelli]

@jorenvh1
I believe that works for GET method, but not for POST.
You set that option(image) add_header on nginx?

[jorenvh1]

@andreluizlunelli I set these headers in my symfony api with the nelmio CORS package (https://github.com/nelmio/NelmioCorsBundle)

[jorenvh1]

I had to add the 'Link' header to the expose_headers array in my NelmioCors config to fix this issue ;)