Git Product home page Git Product logo

rest-springfox's Introduction

Build Status

REST Springfox/Swagger Example

This is a Springfox/Swagger example for documenting REST endpoints.

Build

Execute the following command from the parent directory:

mvn clean install

Once the build completes successfully, you should have the artifact rest-springfox.war in the target folder.

Deploy

You can deploy the rest-springfox.war in a Tomcat web container or any other JEE web container of your choice.

Swagger Endpoints

Once you have successfully deployed the war file, the Swagger endpoints can be accessed at:

  1. Testing Swagger 2.0 JSON API documentation

    http://localhost:8080/rest-springfox/v2/api-docs

  2. Testing Swagger UI

    http://localhost:8080/rest-springfox/swagger-ui.html

If you are interested in knowing more about this project, you can find in my blog 'Swagger for the REST of Us' .

rest-springfox's People

Contributors

indrabasak avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.