How to generate REST API documentation

The LS ones are good, the swagger function is still weak, and the localization is not very good. Eolinker is recommended, visual interface is recommended, support automatic generation of documents, support mock data, automated testing, generate SDKs, team collaboration, etc. EOLINKER is also the largest interface management platform in China

If you want to generate RESTful documentation, you can fill in some basic API information on Eolinker.

REST is an abbreviation for Representational State Transfer, and the literal translation is Representational State Transfer.

RESTful API is a REST-style network interface, which describes a form of interaction between a client and a server in the network. REST itself is not practical, what is practical is how to design.

In the RESTful API provided by the server, only nouns are used in URLs to specify resources, and verbs are not used in principle. "Resources" are at the heart of REST architecture, or the entire network process.

rest aplRefers to a set of architectural constraints and principles that meet the design of an application. Architecture, software architecture is divided into three parts: build, which is used to describe the computer; connectors, which describe the link section of the build; The configuration makes the build and connector a cohesive whole.

A software architecture style, a design style, not a standard, simply provides a set of design principles and constraints. It is mainly used for client-server interaction class software. Software designed based on this style can be more concise, more hierarchical, and easier to implement mechanisms such as caching.

Principle conditions: REST refers to a set of architectural constraints and principles. An application or design that satisfies these constraints and principles is RESTful.

The most important REST principle of a web application is that the interaction between the client and the server is stateless between requests. Every request from the client to the server must contain the information necessary to understand the request. If the server restarts at any point in time between requests, the client is not notified.

In addition, stateless requests can be made by any available server, which is ideal for environments such as cloud computing. Clients can cache data to improve performance.

Definition rules: Resources in REST do not refer to data, but to a combination of data and representation, for example, "the 10 most recently accessed members" and "the 10 most active members" may overlap or be identical in data, and because of their different manifestations, they are classified as different resources, which is why the full name of REST is representational state transfer.

The resource identifier is the URI (Uniform Resource Identifier), whether it is a **, Word, ** file, or even just a virtual service, and whether you are in XML (a subset of the standard Common Markup Language) format, TXT file format or other file formats, all of which uniquely identify resources through URI.

The full spelling of REST is (representational state transfer). REST refers to a set of architectural constraints and principles that meet the requirements of an application design that is RESTful.

REST refers to a set of architectural constraints and principles that meet the constraints and principles of application design.

The REST API, no matter how lofty its name, is essentially an HTTP request, whether it is POST or GET, it is a different way to submit data. Therefore, it is possible to determine the following aspects of a REST API: uri, parameters, request method, request header, etc.

The architecture of the API platform is actually closely related to the business system architecture of the underlying company, and it is basically a matter of course to write a REST API platform based on a good system architecture.

REST is one of the most popular API design theories. Because it has a clear structure, conforms to standards, is easy to understand, and easy to expand, it is used in more and more application scenarios. REST (Representational State Transfer), first appeared in 2000 in Dr. Roy Thomas Fielding, refers to a set of architectural constraints and principles.

An application or design that satisfies these constraints and principles is RESTful.

REST (Representational State Transfer), first published in 2000 by Dr. Roy Thomas Fielding, proposed a World Wide Web software architecture style - REST, which aims to facilitate the transfer of information between different software programs (e.g., the Internet). It refers to a set of architectural constraints and principles.

An application or design that satisfies these constraints and principles is RESTful.

Resources, REST is the "presentation state transition", in fact, it omits the subject. The "presentation layer" actually refers to the "presentation layer" of the "resource". So what is a resource?

Usually access to the Internet**, text, documents, and more ** are resources, which are generally located by uri. In other words, a URI represents a resource.

At the representation level, a resource is used as a specific entity information, which can be presented in a variety of ways. And the presentation of the entity is the presentation layer. For example, a txt text message, which can be output as html, json, etc.

State transfer, accessing a **, represents an interaction between the client and the server. In this process, there is a change in data and state. The HTTP protocol is stateless, so the state must be stored on the server side, so if the client wants to notify the server of the change in data and state, it needs to notify it in some way.

The only way the client can notify the server is the HTTP protocol. Specifically, in the HTTP protocol, there are four verbs that indicate the mode of operation: get, post, put, and delete.

They correspond to four basic operations:

get to get resources.

POST is used to create a new resource (and can also be used to update a resource).

put is used to update the resource.

delete is used to delete the resource.

Web Links.