OpenAPI or swagger.json auto discovery

Question

Is there any spec or convention on URL where one should place swagger.json (or whatever name it is agreed) so that public API of my site can be automatically di

Answer 1

Okay. OpenAPI 3.0 still lacking auto-discovery mechanism, I try to propose a scheme based on some things that were already working:

1. https://example.com/.well-known/schema-discovery is a JSON document pointing to array of available schemas:

   [
     {
       "schema_url": "/openapi.json",
       "schema_type": "openapi-3.0"
     },
     {
       "schema_url": "/v2/openapi.json",
       "schema_type": "openapi-3.0"
     }
   ]
   

2. If there is only one version of API, then https://example.com/openapi.json should be enough.

3. HTTP Headers. I remember somebody from Google proposed HTTP header for pointing to API. If you can find or remember it, please tell me.