Swagger Auto Host

Swagger Auto Host是一个由Swagger提供支持的开源工具，旨在帮助程序员轻松地将他们的API文档托管在web服务器上。

本工具提供了易于使用的命令行界面，可以帮助程序员配置和启动一个基于Swagger的RESTful API文档托管服务。用户只需要提供Swagger规范的JSON文件，本工具就会自动为其生成HTML文档，并将其托管在本地或远程服务器上。

安装

Swagger Auto Host可以通过npm进行安装，使用如下命令：

npm install swagger-auto-host -g

功能

Swagger Auto Host提供了以下主要功能：

• 支持运行本地和远程服务器
• 自动生成并托管Swagger规范的HTML文档
• 支持多个Swagger规范文件

使用方法

使用Swagger Auto Host非常简单。用户只需要在命令行中运行以下命令：

sah serve -s <swagger-spec-file-path>

其中，<swagger-spec-file-path>是指Swagger规范文件的路径。例如：

sah serve -s ./swagger.json

本工具还支持其他可选参数，如运行端口号等。用户可以输入以下命令查看所有参数：

sah serve -h

示例

以下是一个示例，演示如何使用Swagger Auto Host：

1. 首先安装Swagger Auto Host：

   npm install swagger-auto-host -g
   

2. 在本地创建一个名为swagger.json的Swagger规范文件。

   {
       "swagger": "2.0",
       "info": {
           "title": "Example API",
           "version": "1.0.0"
       },
       "paths": {
           "/hello": {
               "get": {
                   "description": "Say hello!",
                   "responses": {
                       "200": {
                           "description": "OK",
                           "schema": {
                               "type": "string"
                           }
                       }
                   }
               }
           }
       }
   }
   

3. 在命令行中运行以下命令启动Swagger服务：

   sah serve -s ./swagger.json
   

   可以看到以下输出：

   Swagger auto host starting...
   Swagger spec file parsed successfully at: ./swagger.json
   Swagger html documentation generated and hosted at: http://localhost:3000
   

4. 在浏览器中打开http://localhost:3000，可以看到自动生成的Swagger文档界面。

   

   在该界面中，可以通过点击右上角的Try it out按钮，测试API的响应结果。

   GET /hello
   
   Responses
   
   200
   
   "OK"
   

总结

Swagger Auto Host是一个易于使用的、快速生成Swagger规范HTML文档并托管的工具。它提供了方便的命令行参数，支持本地和远程服务器，用户只需通过简单的命令行操作即可轻松启动和管理API服务。