https://github.com/dilipkrish/spring-cli-mvc-swagger
Documenting your tweetable services
https://github.com/dilipkrish/spring-cli-mvc-swagger
Last synced: about 1 year ago
JSON representation
Documenting your tweetable services
- Host: GitHub
- URL: https://github.com/dilipkrish/spring-cli-mvc-swagger
- Owner: dilipkrish
- License: apache-2.0
- Created: 2014-09-09T03:29:03.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2014-09-09T04:09:49.000Z (almost 12 years ago)
- Last Synced: 2024-10-05T21:41:40.331Z (over 1 year ago)
- Language: Groovy
- Homepage:
- Size: 133 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Documenting your tweetable services
===================================
Starting from where [getting started with spring boot cli](http://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference/htmlsingle/#getting-started-cli-example) leaves you... here is a quick start guide to documenting your _tweetable_ services.
This example uses [swagger-springmvc](https://github.com/martypitt/swagger-springmvc)
- Grab dependencies
```groovy
@Grab(group='com.mangofactory', module='swagger-springmvc', version='0.8.8')
@Grab(group='org.ajar', module='swagger-spring-mvc-ui', version='0.2') //Webjar to support swagger UI
```
- Enable swagger support - add the following annotations to the controller
```
@com.mangofactory.swagger.plugin.EnableSwagger
```
- Run the application
```bash
spring run app.groovy
```
- Documentation should be available @ http://localhost:8080/index.html
- Replace the stalk swagger end-point with http://localhost:8080/api-docs