Swagger

[Pages:15]swagger

#swagger

1

1: swagger

2

2

Examples

2

- - Node.js

2

2: springfox

4

Examples

4

4

4

4

spring-bootswagger-uispringfox

4

1Mavenspringfox

4

2swagger

5

3API

5

3: UI

6

6

Examples

6

swagger-ui with jersey REST WS

6

13

You can share this PDF with anyone you feel could benefit from it, downloaded the latest version from: swagger

It is an unofficial and free swagger ebook created for educational purposes. All the content is extracted from Stack Overflow Documentation, which is written by many hardworking individuals at Stack Overflow. It is neither affiliated with Stack Overflow nor official swagger.

The content is released under Creative Commons BY-SA, and the list of contributors to each chapter are provided in the credits section at the end of this book. Images may be copyright of their respective owners unless otherwise specified. All trademarks and registered trademarks are the property of their respective company owners.

Use the content presented in this book at your own risk; it is not guaranteed to be correct nor accurate, please send your feedback and corrections to info@



1

1: swagger

swagger

swagger

Examples

- - Node.js

SwaggerREST API/ SwaggerAPIswagger

JSONYAMLswagger.jsonswagger.yaml http //swagger.io/specification/

1. APIswaggerswaggerswagger-codegenswagger-uiAPI 2. swaggerJAX-RSswagger-coreswaggerswagger-codegenswagger-uiAPIswagger

mavenmaven

swaggerswagger UISDKNodeswagger

npm install -g swagger

'-g'

swagger project create

REST API ExpressREADME.md

? API / / / / /

?/ ?/

API / /

? app.js ? package.json

swagger project start

localhostapp.jsapp.js UIREST API

swagger project edit

swaggerhello GETswagger.yaml



2

pathsx-swagger-router-controllercontrollersjavascripthello_world.jscontrollers operationId javascriptswaggerAPI

swagger



3

2: springfox

Examples

SpringfoxAPI201 - Created204 - No Content 40xAPI

? @ApiResponses ?

docket.useDefaultResponseMessages(false);

@ApiResponses(value = { @ApiResponse(code=400, message = "This is a bad request, please stick to the API

description", response = RestApiExceptionModel.class), @ApiResponse(code=401, message = "Your request cannot be authorized.", response =

RestApiExceptionModel.class) })

ModelRef errorModel = new ModelRef("RestApiExceptionModel"); List responseMessages = Arrays.asList(

new ResponseMessageBuilder().code(401).message("Unauthorized").responseModel(errorModel).build(),

new ResponseMessageBuilder().code(403).message("Forbidden").responseModel(errorModel).build(),

new ResponseMessageBuilder().code(404).message("NotFound").responseModel(errorModel).build());

docket.globalResponseMessage(RequestMethod.POST, responseMessages) .globalResponseMessage(RequestMethod.PUT, responseMessages) .globalResponseMessage(RequestMethod.GET, responseMessages) .globalResponseMessage(RequestMethod.DELETE, responseMessages);

spring-bootswagger-uispringfox

1. MavenGradlespringfox 2. Docket bean 3. API 4.

1Mavenspringfox

pom.xmlswagger2swagger-ui

io.springfox springfox-swagger2 2.6.0



4

io.springfox springfox-swagger-ui 2.6.0

2swagger

@EnableSwagger2@SpringBootApplicationswagger Docket bean

@Bean public Docket api() {

return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.any()) .paths(PathSelectors.any()) .build();

}

APIAPIRequestHandlerSelectors

RequestHandlerSelectors.basePackage("your.package.structure")

RequestHandlerSelectors.withClassAnnotation(Api.class)API

3API

apiDocket beanApiInfoBuilder

ApiInfoBuilder

// Within your configuration class public static ApiInfo metadata(){

return new ApiInfoBuilder() .title("Your Title") .description("Your Description") .version("1.x") .build();

}

// Within your method that definies the Docket bean... docket.apiInfo(metadata());

springfox



5

3: UI

REST WS ConceptsJAX-RSWebREST APIMaven

Examples

swagger-ui with jersey REST WS

Swagger SwaggerREST APISwaggerSwagger Mavenjersey Maven SwaggerJAX-RS"maven webapp"webappURLwebapp

1. java" ApiOriginFilter.java "

import javax.servlet.FilterChain; import javax.servlet.FilterConfig; import javax.servlet.ServletException;

import javax.servlet.ServletRequest; import javax.servlet.ServletResponse; import javax.servlet.http.HttpServletResponse; import java.io.IOException;

public class ApiOriginFilter implements javax.servlet.Filter { /** * doFilter */ @Override public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException { HttpServletResponse res = (HttpServletResponse) response; res.addHeader("Access-Control-Allow-Origin", "*"); res.addHeader("Access-Control-Allow-Methods", "GET, POST, DELETE, PUT"); res.addHeader("Access-Control-Allow-Headers", "Content-Type, api_key, Authorization"); chain.doFilter(request, response); }



6

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download