SwaggerEditor基本使用

Posted caomusheng

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了SwaggerEditor基本使用相关的知识,希望对你有一定的参考价值。

项目开发用了RESTful架构,简单理解就是

(1)每一个URI代表一种资源;

(2)客户端和服务器之间,传递这种资源的某种表现层;

(3)客户端通过四个HTTP动词,对服务器端资源进行操作,实现"表现层状态转

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

2 SwaggerEditor安装与启动

(1)下载 https://github.com/swagger-api/swaggereditor/releases/download/v2.10.4/swagger-editor.zip。

(2)解压swagger-editor,

(3)全局安装http-server(http-server是一个简单的零配置命令行http服务器)

npm install ‐g http‐server

  

(4)启动swagger-editor 

http‐server swagger‐editor

  

(5)浏览器打开: 

http://localhost:8080

  注意:在启动cmd命令时,要在swagger-editor的父目录下运行,不然会出现not found错误

 

以上是关于SwaggerEditor基本使用的主要内容,如果未能解决你的问题,请参考以下文章

SwaggerEditor:如何编写RESTful API文档

html PHP代码片段: - AJAX基本示例:此代码演示了使用PHP和JavaScript实现的基本AJAX功能。

c_cpp Robolution基本代码片段

使用Swagger构建Node.js API文档与Mock Server

如何从片段外部清除/重置地图?

JavaScript 代码片段