OpenAPI或swagger.json自动发现

Question

是否有任何关于URL的规范或约定，应该放置swagger.json（或者同意的任何名称），以便可以自动发现我网站的公共API？

Answer 1

2017年4月19日更新：我之前提供的OpenAPI Wiki回答是"for a very very very old version of the spec"。相同的来源指出，对于2.0，标准为swagger.json，对于3.0，它将更改为openapi.json。

原始答案：

  

使用/api-docs端点的OpenAPI Wiki recommends，at   至少对于服务器API。我在野外见过几个使用过的网站   那，这是我们的商店标准。

希望有所帮助。

Answer 2

如何在HTTP响应主体中提供Swagger JSON，以响应对URL的OPTIONS请求？

relevant RFC特别允许这样做。

此外，请考虑将HATEOAS实施为strongly advocated by Roy Fielding。

Answer 3

好的。 OpenAPI 3.0仍然缺乏自动发现机制，我尝试提出一种基于some things且已经有效的方案：

1. https://example.com/.well-known/schema-discovery是一个JSON文档，指向可用模式的数组：

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

2. 如果只有一个API版本，那么https://example.com/openapi.json就足够了。

3. HTTP标头。我记得Google有人提议使用HTTP标头指向API。如果您能找到或记住它，请告诉我。