Skip to content

Commit

Permalink
docs: Added README
Browse files Browse the repository at this point in the history
  • Loading branch information
Javakky-pxv committed Jul 13, 2022
1 parent e12f856 commit 08d129a
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -281,6 +281,20 @@ e.g.
GET /docs/swagger-ui/*file controllers.Assets.at(path:String="/public/lib/swagger-ui", file:String)
```

Multiple lines can be skipped.

※NoDocsEnd must always be listed directly before one line as a comment on <b>the endpoint not to be skipped</b>, or on the last line of the routes fill.

```
### NoDocsStart ###
GET /api/hidden/a controllers.hiddenEndPointA()
GET /api/hidden/b controllers.hiddenEndPointB()
### NoDocsEnd ###
GET /api/hidden/c controllers.hiddenEndPointC()
```

#### How to specify body content in a POST endpoint
Body content is specified as a special parameter in swagger. So you need to create a parameter in your swagger spec comment as "body", for example
```
Expand Down

0 comments on commit 08d129a

Please sign in to comment.