Giter VIP home page Giter VIP logo

spring-boot-starter-swagger2's Introduction

spring-boot-starter-swagger2

A spring boot starter with swagger 2.0 api documentation enabled

Base on springfox Swagger2, you can find more information from springfox

How to build and install

  1. git clone the code from github

  2. run the command in your console with maven:

	mvn install

How to use

  • import the config in you pom.xml
<dependency>
    <groupId>com.github.ganity</groupId>
    <artifactId>spring-boot-starter-swagger2</artifactId>
    <version>0.0.1-SNAPSHOT</version>
</dependency>
  • add the follow config in you application.yml or application.properties
swagger:
  enable: true #if enable swagger
  group: item #the api group name 
  title: item-title #the title
  description: item description
  version: v1.10
  contact-name: ganily
  contact-url: http://www.aaa.com
  contact-email: [email protected]
  base-package: video.lark.mall.item.service #the base package for RequestHandlerSelectors default all the package
  terms-of-service-url: https://github.com/ganity
  license: Apache License Version 2.0
  license-url: https://github.com/springfox/springfox/blob/master/LICENSE
  • run your Application

Paths

  • All Swagger Resources(groups) http://localhost:8080/springfox/swagger-resources
  • Swagger UI endpoint: http://localhost:8080/springfox/swagger-ui.html
  • Swagger docs endpoint: http://localhost:8080/springfox/v2/api-docs

spring-boot-starter-swagger2's People

Contributors

ganity avatar

Stargazers

 avatar  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.