Swagger API Tools

External

• https://github.com/swagger-api/

Internal

• Swagger
• Amazon API Gateway Importer

Swagger Core

OpenAPI 3.0 implementation https://github.com/swagger-api/swagger-core

OpenAPI 2.0 implementation https://github.com/swagger-api/swagger-core/tree/1.5

Swagger Core Playground Example

Playground swagger-core Example

Parsing Swagger

import io.swagger.models.Swagger;
import io.swagger.parser.SwaggerParser;

...

String filePath = ...;
final SwaggerParser parser = new SwaggerParser();
Swagger swagger = parser.read(filePath);

Render Swagger as Yaml

Render Swagger as Yaml

import io.swagger.models.Swagger;
import io.swagger.util.Yaml;

Swagger swagger = ...
String s = Yaml.mapper().writeValueAsString(swagger);

Alternative:

String s = Yaml.pretty(swagger);

Render Swagger as Json

Render Swagger as Json

import io.swagger.models.Swagger;
import io.swagger.util.Json;

Swagger swagger = ...
String s = Json.mapper().writeValueAsString(swagger);

Alternative:

String s = Json.pretty(swagger);

Swagger Parser

Swagger Parser 1.X (OpenAPI 2.0) https://github.com/swagger-api/swagger-parser/tree/v1

Swagger Parser 2.X (OpenAPI 3.0) https://github.com/swagger-api/swagger-parser

Swagger Parser Overview

Swagger Parser dependes on Swagger Core.

Swagger Parser Playground Example

Playground swagger-parser Example

Dependencies

dependencies {

    implementation "io.swagger:swagger-parser:1.0.42"
    implementation "io.swagger:swagger-parser:1.0.42:sources"

}