Introduction to the rest Modeling Language raml

What is raml? Raml is a simple restful API descriptive language. It is built based on public standards such as yaml and JSON. Through raml definition, you can generate the client call code and server code structure, and create API instructions. We know that the Web Service has a corresponding WSDL to describe its schema. The WSDL is equivalent to a description of the current service, and the client can generate the corresponding proxy Code accordingly, therefore, WSDL can help clients consume services more easily. For restful APIs, there is no corresponding "Rest WSDL". In this case, raml came into being and can provide a complete description of our APIs, whether for humans or machines, can be used in a relatively friendly way. What does raml help us do? Raml can help you organize: 1. Basic information. Describes the key points of a restful API, such as the name, title, and path. 2. User documentation. Describes the technical support documentation to help users consume APIs more conveniently. You can use the document builder to create PDF or HTML. 3. Resources. Describes how to standardize restful resources, resource methods and schemas, and interactions between resources.
How to Use raml to design APIs? Online designer: plugin. Raml designer and parser are both GitHub's open-source projects. We can integrate them into our own products. The document above is generated using the raml parser. It is a Javascript file about KB after compression and can be loaded to a browser or node. run in JS. The parser can load the specified raml file to generate HTML documents. Where are raml-related tools and resources?   Official Website: http://raml.org specifications Documentation:

Introduction to the rest Modeling Language raml