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 discovered?
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 discovered?
Updated 19 April 2017: The OpenAPI Wiki answer I gave previously is "for a very very very old version of the spec". The same source states that for 2.0 the standard is swagger.json
, for 3.0 it changes to openapi.json
.
Original answer:
The OpenAPI Wiki recommends using an
/api-docs
endpoint, at least for server APIs. I've seen several sites in the wild that use that, and it's our shop standard.
Hope that helps.