Simple example of Springboot integration Swagger2

Swagger is a normative and complete framework for generating, describing, invoking, and visualizing RESTful Web services. The overall goal is to have the client and the file system update at the same speed as the server. File methods, parameters and models are tightly integrated into the server-side code, allowing the API to always stay in sync. Swagger making deployment management and using powerful APIs has never been easier.

Here I bring you a simple integration demo first look at the project structure

Here are the basic steps

I. Adding MAVEN dependencies

2. <dependency>
4. <groupId>io.springfox</groupId>
6. <artifactId>springfox-swagger2</artifactId>
8. <version>2.2.2</version>
10. </dependency>
12. <dependency>
14. <groupId>io.springfox</groupId>
16. <artifactId>springfox-swagger-ui</artifactId>
18. <version>2.2.2</version>
20. </dependency>
22. <dependency>
24. <groupId>org.codehaus.jackson</groupId>
26. <artifactId>jackson-core-asl</artifactId>
28. <version>1.9.13</version>
30. </dependency>

Two. Writing the Swagger configuration class

2. @Configuration
4. @EnableSwagger2
6. Public class Swaggers {
10. @Bean
12. Public Docket Swaggerspringmvcplugin () {
14. Apiinfo apiinfo = new Apiinfo ("Sample of Springboot", "sample of Springboot", null, null, null, null, null);
16. Docket Docket = new Docket (documentationtype.swagger_2). Select (). Paths (Regex ("/user/.*")). Build ()
18. . Apiinfo (Apiinfo). Usedefaultresponsemessages (false);
20. return docket;
22. }
28. /*private apiinfo apiinfo () {
30. return new Apiinfobuilder (). Title ("Test API")
32. . Description ("Shian Test API1")
34. . Version ("1.0.0")
36. . build ();
38. }*/
40. / * @Bean
42. Public Docket Createrestapi () {
44. return new Docket (documentationtype.swagger_2)
46. . Apiinfo (Apiinfo ())
48. . Select ()
50. . APIs (Requesthandlerselectors.basepackage ("Com.didispace.web"))
52. . Paths (Regex ("/user/.*"))
54. . build ();
56. }
58. */
62. }

Of course, it can be implemented in a chained programming way, where I use new

Three. Writing a controller

2. @RestController
4. @RequestMapping ("/user")
6. @Api (value = "Shop")
8. Public class Springbootcontroller {
12. @ApiOperation (value = "Get HelloWorld", notes = "simple SPRINGMVC Request")
14. @RequestMapping ("/")
16. String Home () {
18. return "HELLO World";
20. }
24. @ApiOperation (value = "Get A+b", notes = "Add a string of request parameters based on the URL's classno and URL studentname, restful style request")
26. @ApiImplicitParams ({@ApiImplicitParam (name = "Classno", value = "class number", Required = true, DataType = c8> "String"),
28. })
30. @RequestMapping (value = "/class/{classno}/to/{studentname}", method = Requestmethod.get)
32. String World (@PathVariable ("Classno") string Classno, @PathVariable ("Studentname") string Studentname) {
34. return Classno + "" + studentname;
36. }
42. }

Four. Writing application loading class

1. @SpringBootApplication
2. Public class Application {
3. public static void Main (string[] args) {
4. Springapplication.run (Application.   Class,args);
5. }
7. }

Swagger will default to all controllers in the Requestmapping method generated API out, in fact, we generally only need the standard interface (like the controller method returned to the page we do not need), All you can do is to set the requirements for the method to generate the API as follows.

This function is basically implemented, we can access the address http://localhost:8080/swagger-ui.html/

View the generated API

Simple example of Springboot integration Swagger2