场景.使用raml构建接口文档
1.安装能够将raml 转化为 html 文件的 raml2html工具 安装步骤如下
npm i -g raml2html2.将编辑好的raml文件生成html文件以便查阅
raml2html test.v1.raml > test.v1.html3.下载mock服务以便能够通过http服务访问接口
如果在下载过程中出错诸如(rollbackFailedOptional: verb npm-session),可以使用如下代理
npm config set registry http://registry.npmjs.org/ 3.1下载服务设置
npm install -g osprey-mock-service3.2 运行指定的raml文件并设置访问端口osprey-mock-service -f stock.v1.raml -p 80894.测试 假设 raml文件中包含如下路径信息
http://127.0.0.1:8089/recommend/find
在浏览器中访问可获取到相应的返回值
本文档介绍如何使用RAML构建API接口文档,并提供详细的步骤说明。包括安装raml2html工具、生成HTML文档及设置mock服务等。适用于希望提高接口文档质量和便捷性的开发者。
7671

被折叠的 条评论
为什么被折叠?



