https://github.com/naxa777/stackoverflow-swagger-apiresponses

https://github.com/naxa777/stackoverflow-swagger-apiresponses

gradle java8 spring-boot-2 spring-mvc springfox swagger-annotations swagger-ui

Last synced: 10 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/naxa777/stackoverflow-swagger-apiresponses
• Owner: naXa777
• License: cc-by-sa-4.0
• Created: 2018-11-12T19:39:06.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2018-11-12T20:16:57.000Z (almost 6 years ago)
• Last Synced: 2024-10-06T20:41:18.448Z (about 1 month ago)
• Topics: gradle, java8, spring-boot-2, spring-mvc, springfox, swagger-annotations, swagger-ui
• Language: Java
• Homepage:
• Size: 91.8 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Swagger @ApiResponses Demo

A mini project to answer a Stack Overflow [question](https://stackoverflow.com/q/46324478/1429387) about Swagger annotations.

It demonstrates Swagger annotations, specifically [`@ApiResponses`](http://docs.swagger.io/swagger-core/apidocs/com/wordnik/swagger/annotations/ApiResponse.html), for configuring responses in API documentation.

For more details read [the answer](https://stackoverflow.com/a/53266819/1429387).

## Technologies

* Java 8

* Spring Boot 2

* Spring MVC

* Springfox

* Gradle

## Build

[![Build Status](https://travis-ci.com/naXa777/stackoverflow-swagger-apiresponses.svg?branch=master&style=flat)](https://travis-ci.com/naXa777/stackoverflow-swagger-apiresponses)

```$sh

./gradlew bootRun

```

Open http://localhost:8080/swagger-ui.html in browser.

## Screenshots

![Swagger UI](/screenshots/api-documentation.png)

## License

This work is licensed under [Creative Commons Attribution-Share Alike](https://creativecommons.org/licenses/by-sa/4.0/). [Proper attribution](https://stackoverflow.blog/2009/06/25/attribution-required/) is required if you republish this repository content.