手机网站头部代码,网络黄推广软件,海盐建设局网站,seo职位招聘该帖子最初在http#xff1a;// swag ger.io#xff08;7/30/2015#xff09;上发布 我一直在将Play Framework用作几个项目的基于Java的#xff0c;快速的REST后端框架。 后来#xff0c;我很高兴找到Swagger#xff0c;并努力将其集成到几个项目中。 在我第一次挣扎时… 该帖子最初在http// swag ger.io7/30/2015上发布 我一直在将Play Framework用作几个项目的基于Java的快速的REST后端框架。 后来我很高兴找到Swagger并努力将其集成到几个项目中。 在我第一次挣扎时我认为分享经验并撰写一篇“如何做”的文章来描述快速成功的步骤将很有用。 为了简化操作我开始使用James Ward创建的现有Play框架JavaJPAREST项目。 James的项目位于GitHub上因此在开始此方法之前 应先将其拉出 。 操作步骤 首先将依赖项添加到build.sbt中。 我可以通过参考GitHub问题55o解决示例项目中使用的Play Framework 2.3.0版本和swagger-core的依赖问题 https// g g e r-p i / s w g g e r-c o r e / i你/ 550 。 com.wordnik %% swagger-play2 % 1.3.12 exclude(org.reflections, reflections),
org.reflections % reflections % 0.9.8 notTransitive (),
org.webjars % swagger-ui % 2.1.8-M1 将此添加到您的配置application.conf中 api.version1.0 swagger.api.basepathhttp://localhost:9000 将api-docs路由添加到路由文件 GET / controllers.Assets.at(path/public, fileindex.html)GET /api-docs controllers.ApiHelpController.getResourcesPOST /login controllers.SecurityController.login() POST /logout controllers.SecurityController.logout()GET /api-docs/api/todos controllers.ApiHelpController.getResource(path /api/todos)
GET /todos controllers.TodoController.getAllTodos()
POST /todos controllers.TodoController.createTodo()# Map static resources from the /public folder to the /assets URL path
GET /assets/*file controllers.Assets.at(path/public, file) 将Swagger注释添加到ToDoControllerApi Api(value /api/todos, description Operations with Todos)
Security.Authenticated(Secured.class)
public class TodoController extends Controller { 然后是GET和POST方法的注释 ApiOperation(value get All Todos,notes Returns List of all Todos,response Todo.class, httpMethod GET)
public static Result getAllTodos() { return ok(toJson(models.Todo.findByUser(SecurityController.getUser())));
}
ApiOperation( nickname createTodo, value Create Todo, notes Create Todo record, httpMethod POST, response Todo.class)
ApiImplicitParams( { ApiImplicitParam( name body, dataType Todo, required true, paramType body, value Todo ) }
)
ApiResponses( value { com.wordnik.swagger.annotations.ApiResponse(code 400, message Json Processing Exception) }
)
public static Result createTodo() { Formmodels.Todo form Form.form(models.Todo.class).bindFromRequest(); if (form.hasErrors()) { return badRequest(form.errorsAsJson()); } else { models.Todo todo form.get(); todo.user SecurityController.getUser(); todo.save(); return ok(toJson(todo)); }
} 启动应用程序然后在浏览器中转到以下URL http://localhost:9000/assets/lib/swagger-ui/index.html?/urlhttp://localhost:9000/api-docs 源代码 如开始所述我从James Ward在github上的play-rest-security开始并在我的fork上进行了这些修改。 对于所有感兴趣的人这里是源代码 https//紧急情况 注意同时James Ward批准了我的拉取请求将这些更改添加到他的项目GitHub中因此您应该将其拉出 翻译自: https://www.javacodegeeks.com/2015/08/its-easy-to-document-your-play-framework-rest-api-with-swagger.html
