Swagger Editor教程

最新推荐文章于 2024-08-08 08:31:05 发布

benben_2015

最新推荐文章于 2024-08-08 08:31:05 发布

阅读量2.4w

点赞数 10

分类专栏： swagger 文章标签： swagger editor

本文链接：https://blog.youkuaiyun.com/benben_2015/article/details/90046046

版权

Swagger Editor是一个强大的API设计工具，支持Windows平台安装。它提供了交互式文档、代码生成SDK和API发现功能。安装过程包括安装Node.js和npm，下载Swagger Editor源码并启动服务。使用Swagger Editor编写YAML格式的API文档，可享受语法高亮、自动补全和实时预览等优势。通过示例展示了如何声明API规范、定义操作、响应类型和请求参数，以及如何处理body参数和引用定义。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

Swagger是一个简单但功能强大的API表达工具，是目前现有的最大API工具生态系统。使用Swagger生成API，我们可以得到交互式文档，自动生成代码的SDK以及API的发现特性等。

安装

Windows上的安装

1、首先需要安装node和npm。你可以在cmd命令行看到你的安装信息。使用命令node -v和npm -v，可以用来查看版本信息。
2、安装后，还需要安装http-server。使用命令npm install -g http-server。
3、接着去Swagger Editor官网下载源码。
在这里插入图片描述
4、下载完成后，从命令行中进入http-server的安装目录，也就是npm包下载的位置。

5、最后将swagger editor服务启动起来

上面红色标记的是Swagger Editor压缩包解压后的位置。启动成功后，在浏览器中输入127.0.0.1:8081就可以看到下面的界面。
在这里插入图片描述

使用

我们可以选择使用JSON或者YAML的语言格式来编写API文档，但是建议用YAML来写，因为它更简单。编写API文档，我们只是在写一个简单的文本文件。我们可以使用任何文档编辑器来写，但是为了提高效率，建议使用专业的编辑工具。众多工具中，最好的选择就是Swagger Editor。它能提供语法高亮、自动补全、及时预览等功能。

例子

swagger: '2.0'

info:
  version: 1.0.0
  title: Simple API
  description: A simple API to learn how to write OpenAPI Specification

schemes: 
  - https
host: simple.api
basePath: /openapi01

paths: {}

第一行通过swagger属性来声明OpenAPI规范的版本，OpenAPI规范是基于Swagger的，目前这个属性的值只能是2.0.接着是API的描述信息，用info属性。
接着是API的URL&#