多个API文档(“视图”)欧宝官网下载app
编辑该页面警告:你正在浏览的文档版本欧宝官网下载app2.倍这是不再维护。
如果你的一些项目仍然使用这个版本,考虑升级。
多个API文档(“视图”)欧宝官网下载app
与的观点
标签的@ApiDoc
注释,可以创建不同的观点你的API文档。欧宝官网下载app没有标签,位于所有方法默认的
视图,可以发现在正常的API文档的url。欧宝官网下载app
您可以指定一个或多个视图这些方法是可见的。
一个例子:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21日22日23日24日25
/ * * * * *的资源@ApiDoc(*资源= true, *描述= "这是你的API方法”的描述,*观点={“违约”、“溢价”}*)* /公共函数getAction(){}/ * * * * *另一种资源@ApiDoc(*资源= true, *描述=“这是另一个API方法的描述”,*观点={“溢价”}*)* /公共函数getAnotherAction(){}
在这种情况下,只有第一个资源可以在默认视图,而下这两种方法都可以溢价
视图。
访问特定API的观点
的默认的
视图可以在正常的位置。可以发现在其他视图http://your。欧宝官网下载app文档/ <视图名称>
。
例如,如果你的文件位于:欧宝官网下载app
1
http://example.org/doc/api/v1/
然后溢价
视图将位于:
1
http://example.org/doc/api/v1/premium
这项工作,包括代码示例,许可下Creative Commons冲锋队3.0许可证。