RESTful-style Web services Framework Swagger

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.

1. Create a project

1.REST API

2. Import Javax.ws.rs.Consumes;
6. Import Javax.ws.rs.GET;
10. Import Javax.ws.rs.POST;
14. Import Javax.ws.rs.Path;
18. Import Javax.ws.rs.PathParam;
22. Import javax.ws.rs.Produces;
26. Import Javax.ws.rs.core.MediaType;
30. Import Com.wordnik.swagger.annotations.Api;
34. Import com.wordnik.swagger.annotations.ApiOperation;
38. @Path ("/user")
42. @Api (value = "/user", description = "User REST for Integration testing")
46. Public interface UserService {
50. @GET
54. @Path ("/getuser/{username}")
58. @Consumes (Mediatype.application_json)
62. @Produces (Mediatype.application_json)
66. @ApiOperation (value = "Get User Details", response = user. ) Class)
70. Public User GetUser (@PathParam ("username") String username);
74. @POST
78. @Path ("/saveuser")
82. @Consumes (Mediatype.application_json)
86. @Produces (Mediatype.application_json)
90. @ApiOperation (value = "Save User Details", response = user. ) Class)
94. Public user getUser (user user);
98. }

2.Swagger Config

2. <!–swagger API Listing resource–>
4. <Bean id="Swaggerresourcejson"
6. class="Com.wordnik.swagger.jaxrs.listing.ApiListingResourceJSON" />
10. <!–swagger writers–>
12. <Bean id="ResourceWriter"
14. class="Com.wordnik.swagger.jaxrs.listing.ResourceListingProvider" />
16. <Bean id="Apiwriter"
18. class="Com.wordnik.swagger.jaxrs.listing.ApiDeclarationProvider" />
22. <jaxrs:server address="/SW" id="swagger">
24. <Jaxrs:servicebeans>
26. <ref bean="Swaggerresourcejson" />
28. </Jaxrs:servicebeans>
30. <jaxrs:providers>
32. <ref bean="ResourceWriter" />
34. <ref bean="Apiwriter" />
36. </jaxrs:providers>
38. </jaxrs:server>
42. <Bean id="Swaggerconfig">
44. <property name= "resourcepackage" value="Com.xymiyue" />
46. <property name="version" value="2.0″ />
48. <property name= "basepath" value="Http://localhost:8080/SwaggerUI-Integration/rest" />
50. <property name="title" value="Swagger UI integration Sample" />
52. <property name="description"
54. value="Swagger UI integration Sample for demonstrating it working." />
56. < name="Contact" value="[email protected]" />
58. <property name="Scan" value="true" />
60. </Bean>

3.Swagger UI

UI page Reference Https://github.com/Duttor/swagger-ui

Reference Example Project:

Https://github.com/saurabh29july/SwaggerUI-Integration

http://wangbaocai.cn/?p=1204

RESTful-style Web services Framework Swagger