Configuration and use of Swagger-ui

Swagger-uiThe official address:

Http://swagger.wordnik.com

Github address of the project on:

Https://github.com/wordnik/swagger-ui

The official demo address provided

http://petstore.swagger.wordnik.com/

Swagger is a normative and complete framework for generating, describing, invoking, and visualizing RESTful Web Services. The goal of Swagger is to define a standard and language-independent interface to the REST API that allows people and computers to discover and understand the capabilities of a service without having to access source, document, or network traffic monitoring. When properly defined through Swagger, users can understand remote services and interact with remote services with minimal implementation logic. Similar to the interface implemented for the underlying programming,Swagger eliminates the guesswork that might occur when invoking a service.

Swagger is a set of open source projects, the main items are as follows:

Swagger-tools: provides a variety of tools for integrating and interacting with Swagger. For example, schema validation,Swagger 1.2 document conversion to Swagger 2.0 document, and other functions.

Swagger-core: The Swagger implementation for Java/scala . With Jax-rs (Jersey,resteasy,CXF ...) , The Servlets and Play Framework are integrated.

Swagger-js: The Swagger implementation for JavaScript .

Swagger-node-express:swagger module for the Express Web application Framework for node. js.

Swagger-ui: A non-dependent HTML,JS, and CSS collection that dynamically generates elegant documents for the Swagger- compliant API .

as the company project is the CI framework, directly in the code through a CI plug-in, the implementation of annotations to generate document functionality, specifically Http://ym1623.github.io/codeigniter_ apidoc/, so this is not the Swagger-ui document generation feature, primarily using its API testing capabilities.

First, download swagger-ui in GitHub

open its dist in the server

this page, by invoking JSON, then implements its specific document test.

you can generate the JSON format files required in Swaggerui by http://www.sosoapi.com/, this platform

Configuration and use of Swagger-ui