OpenAPI 或 swagger.json 自动发现 [英] OpenAPI or swagger.json auto discovery

问题描述

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

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?

推荐答案

2017 年 4 月 19 日更新:我之前给出的 OpenAPI Wiki 答案是 "对于非常非常旧的规范版本".同一来源指出，对于 2.0，标准是 swagger.json，对于 3.0，它更改为 openapi.json.

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.

原答案:

OpenAPI Wiki 推荐使用 /api-docs 端点，在至少对于服务器 API.我在野外看到过几个使用这是我们的商店标准.

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.

希望有所帮助.

这篇关于OpenAPI 或 swagger.json 自动发现的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！