相关疑难解决方法(0)

使用Javadocs生成Swagger文档

我想为现有的一组RESTful API构建Swagger文档.我有以下要求:

  1. 离线生成Swagger Doc(我使用了http://kongchen.github.io/swagger-maven-plugin/).这个插件帮助我在编译期间生成Swagger文档.
  2. 读取现有的Javadoc,以便可以在Swagger文档中使用它们.

到目前为止使用上面的插件我能够实现第1点.所以对于现有的REST方法:

 /**
 * <p>
 * Gets the {@link DisplayPreferenceModel} with the name as provided in the parameter. The preference with the given name defined at the tenant or master level is returned.
 * This API gives us the preference if it is eligible for unauthorized access If it is not eligible it throws an Exception saying Authorization required.
 * </p>
 * @param preferenceName
 *            - The name of the preference.
 * @return {@link …
Run Code Online (Sandbox Code Playgroud)

java maven swagger swagger-maven-plugin

18
推荐指数
1
解决办法
2万
查看次数

标签 统计

java ×1

maven ×1

swagger ×1

swagger-maven-plugin ×1