Swagger自动生成OData技术文档

本文主要是介绍Swagger自动生成OData技术文档，对大家解决编程问题具有一定的参考价值，需要的程序猿们随着小编来一起学习吧！

做后端开发OData开发有一项挺繁琐的工作就是写技术说明书，写清楚每一个Entity，甚至要写每一个Testcase，凡是繁琐的的重复性工作在伟大的互联网上一定可以找到对应的技术手段来帮助我们提高效率。
Swagger的介绍和特性参考这个帖子：https://blog.csdn.net/zmh458/article/details/78766895
我们在api.sap.com中看到的API的技术说明相信也是使用了swagger来自动生成的。

将其API specification下载通过Swagger Editor或是Swagger UI打开看到的内容几乎一致

过程：

1. Gateway开发的OData首先导出metadata文件为xml格式；
2. 使用OData OpenAPI这个工具转换成Json格式的描述文件；
3. 然后就可以用Swagger Editor修改编辑或是Swagger UI进行查看。

两种方式：

OData OpenAPI + Swagger Editor/UI

1. 安装Git和NodeJS

2. git clone

   git clone https://github.com/oasis-tcs/odata-openapi.git
   git clone https://github.com/swagger-api/swagger-editor.git
   git clone https://github.com/swagger-api/swagger-ui.git
   

   下载完成后：
   

3. 然后进到swagger-editor文件夹中安装关联组件并启动swagger editor

   cd swagger-editor
   npm install
   npm run build
   npm start
   

   
   此时就可以按屏幕提示的地址启动浏览器
   

   

ABAP openapi UI

还有一种方案就是直接用ABAPgit安装ABAP openapi UI,这个安装和下载就不必多说了。
直接执行ZGW_OPENAPI

时间仓促，草草结束

这篇关于Swagger自动生成OData技术文档的文章就介绍到这儿，希望我们推荐的文章对大家有所帮助，也希望大家多多支持为之网！