swagger android,Swagger 使用

8种机械键盘轴体对比

本人程序员，要买一个写代码的键盘，请问红轴和茶轴怎么选？

Restful接口规范

描述Restful接口设计、开发、测试(分别模拟客户端和服务器端)、以及联调的方式。

Swagger是一个Restful定义描述语义。围绕Swagger, OpenSource世界提供了一组工具,覆盖了Restful接口定义、接口代码生成等。并可以直接导入Postman或者以mock方式模拟接口调用。

并且,还可以在接口定义中规范参数的格式、有效取值范围等合法性检查。安装swagger工具1$ npm install -g swagger-cli

$ npm install -g swagger-diff

2. API定义文件

所有的接口定义都已.yaml文件表述, 放置在RestAPI/yaml路径下。

文件 | 定义 | 场景

3. 如何检查yaml的语法1$ swagger validate Edi.yaml

4. yaml自动生成markdown文档1$ cd doc/RestAPIs/

$ ../../bin/swagger2markup

$ git commit -m "Updated yaml&md files"

$ git push

将会在/doc/RestAPIs下, 按照yaml定义生成markdown文档, 并git提交到repository中。

5. 生成Server端代码1$ java -jar bin/swagger-codegen-cli.jar generate -l nodejs-server -i doc/RestAPIs/yaml/ -o skeleton/nodejs

node.js代码生成在skeleton/nodejs路径下。然后通过代码合并工具将接口上的新变化合并到scc-src的项目中。

6. 生成客户端javascript代码1$ java -jar bin/swagger-codegen-cli.jar generate -l javascript -i doc/RestAPIs/yaml/ -o skeleton/javascript

客户端javascript代码会生成在skeleton/javascript路径下,然后使用代码合并工具将接口上的新变化合并到scc-react项目中。

7. 生成android客户端代码1$ java -jar bin/swagger-codegen-cli.jar generate -l java -c bin/android_config.json -i doc/RestAPIs/yaml/ -o skeleton/android

Android客户端java代码生成在skeleton/android路径下, 然后使用代码合并工具将接口上的新变化合并到scc-mobile;

8. 生成ios客户端代码1$ java -jar bin/swagger-codegen-cli.jar generate -l objc -i doc/RestAPIs/yaml/ -o skeleton/objc

iOS客户端objective-c代码生成在skeleton/objc路径下, 然后使用代码合并工具将接口上的新变化合并到scc-mobile;

8. mock模式模拟接口

mock模式用来模拟swagger中定义的接口。1$ cd skeleton/nodejs/

$ npm install

$ node .

1$ swagger

9. 导入Postman测试

可以将yaml文件直接import到postman中, 在postman中发起对服务器端的测试。

参考资料: