用于编写 Web 服务文档的软件包

用于编写 Web 服务文档的软件包

是否存在一些用于定义 Web 服务文档的包?

我有一个 RESTful Web 服务。我使用了昂首阔步在 yaml 中创建一些文档。

现在我想向外部开发人员公开我的 API 并解释它的工作原理。

是否存在一个可以为 Web 服务文档添加一些“环境”或读取和可视化 yaml 的包?

我正在寻找类似 Swagger 表示的东西,如本例所示:例子

就像是:

\begin{environment}
   method=post
   url=http://mysite/pet/{id}
   header{name=Authorization,value=AAAA}
\end{environment}

并且神奇地出现了一些格式化的东西。

对于响应,我可以使用\begin{lstlisting}[language=json]一些像示例中那样的自定义。

\begin{lstlisting}[language=json]
{
"access_token": "eyJhJSUzI1...WVrn.eyJleEOTQc...VzZXoidXRlbnRlIn.Zm...WsCWg",
"expires_in": 600,
"refresh_expires_in": 1800,
"refresh_token": "eyJhbG...fQ.eyJleHAiOjE...wifQ.cXW09GD...SXY",
"token_type": "bearer",
"not-before-policy": 1586965065,
"session_state": "e0fab4a9-a374-44e0-9315-75816f19f1e6",
"scope": "profile email"
}  
\end{lstlisting}

相关内容