• 該帖子最初在http：// swag ger.io（7/30/2015）上發(fā)布

我一直在將Play Framework用作幾個(gè)項(xiàng)目的基于Java的，快速的REST后端框架。 后來，我很高興找到Swagger，并努力將其集成到幾個(gè)項(xiàng)目中。 在我第一次掙扎時(shí)，我認(rèn)為分享經(jīng)驗(yàn)并撰寫一篇“如何做”的文章來描述快速成功的步驟將很有用。

為了簡化操作，我開始使用James Ward創(chuàng)建的現(xiàn)有Play框架，Java，JPA，REST項(xiàng)目。 James的項(xiàng)目位于GitHub上，因此在開始此方法之前， 應(yīng)先將其拉出 。

操作步驟

首先，將依賴項(xiàng)添加到build.sbt中。 我可以通過參考GitHub問題55o解決示例項(xiàng)目中使用的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.version="1.0" swagger.api.basepath="http://localhost:9000"

將api-docs路由添加到路由文件： GET / controllers.Assets.at(path="/public", file="index.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注釋添加到ToDoController（@Api）： @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() { Form<models.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)); } }

啟動(dòng)應(yīng)用程序，然后在瀏覽器中轉(zhuǎn)到以下URL：

http://localhost:9000/assets/lib/swagger-ui/index.html?/url=http://localhost:9000/api-docs

源代碼

如開始所述，我從James Ward在github上的play-rest-security開始，并在我的fork上進(jìn)行了這些修改。 對于所有感興趣的人，這里是源代碼：

• https：//緊急情況

注意：同時(shí)，James Ward批準(zhǔn)了我的拉取請求，將這些更改添加到他的項(xiàng)目GitHub中，因此您應(yīng)該將其拉出

翻譯自: https://www.javacodegeeks.com/2015/08/its-easy-to-document-your-play-framework-rest-api-with-swagger.html

總結(jié)

以上是生活随笔為你收集整理的使用Swagger轻松记录您的Play Framework REST API的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。