Shulou(Shulou.com)06/01 Report--

This article focuses on "how to customize yaml file management api and generate a complete program based on yaml file", interested friends may wish to have a look. The method introduced in this paper is simple, fast and practical. Let the editor take you to learn how to customize the yaml file management api and generate a complete program based on the yaml file.

1. Background of api management style

As the project team continues to standardize, every step of the development process is constantly changing, becoming more efficient and easier to manage; api management has also undergone a lot of changes, the main changes from top to bottom:

Writing the back-end interface api, from status's action to springmvc's @ RequestMapping, these frameworks can indeed help us write the back-end interface, but for the front-end separation project, you also need to write the interface document developed by the project team. I believe that not many programmers want to write the interface document after writing the interface.

Due to the large number of project team development systems, in order to uniformly manage the interface documents of all systems within the company, some companies will customize their own interface document management applications at this time. Through this application, we can simply write interface document information directly on the website, without considering the interface document style, etc., which is indeed better than the previous one, by customizing this website We can debug the interface online, manage versions, and assign api management rights. API Management-using the open source xxl-api project management interface

Integrate swagger in the project and annotate the api information on the interface, and view and debug the api interface through the swagger-ui.html interface. For more information, please refer to: API Management-swagger integration based on SpringBoot project to automatically generate interface documents. If you think this set of ui is unfriendly, it can be replaced, API management-abandon springfox-swagger-ui and adopt more feature-rich swagger-bootstrap-ui.

Through the above one can basically complete the api management operation, but such swagger management also has code intrusiveness is too high, in order to achieve the goal also need to repeatedly adjust the interface notes or parameters; since there are problems, after reading this article you will learn: how to customize the yaml file management api and based on the yaml file to generate client side, server side, springboot complete program, and then go to the topic.

two。 There are several concepts that need to be understood

Swagger 2.0 and openapi 3.0 specifications, in fact, is the specification for the definition of yaml file format, different situations can be generated through a specific specification for different back-end code generation, for swagger 2.0 and openapi 3.0 specification generated code plug-ins are also many, swagger 2.0 and openapi 3.0 also support interconversion, please refer to: swagger2openapi.

This paper first introduces the generation of back-end code based on swagger 2.0. I have tried open api 3.0 to do it, but the plug-in is not very powerful and does not achieve the effect I want. It is impossible to achieve: generate client, server and springboot complete programs based on yaml files.

To meet the requirements of swagger 2.0 files, there are two formats: json and yaml, so we can manage the interface as long as we learn to write this yaml or json file writing specification.

3. Use swagger-codegen to generate client-side, server-side and springboot complete programs based on yaml files

Please read this article first, it is well written: the spring boot project uses swagger-codegen to generate jar packages for inter-service calls, Baidu has a lot of posts, and this article gives me the effect I want.

In this way, I can generate a program with only NameApi interface ("interfaceOnly": "true"). By packaging this program and relying on the project, you can complete the management of api. Every time you update the api interface, you only need to write a good yaml to regenerate the jar and rely on the project, which can also reduce the intrusiveness of swagger-related annotations. In this way, you only need to implement the interface in jar on controller, without adjusting the logic in service and mapper, and the service and Mapper layers can also directly generate a common interface to interact with the database in the previous way.

In addition, swagger-codegen can also produce the client code (jar) we want through "library": "feign". The client code here is some encapsulated tools that can interact with server in a specified way, for example, sso-client.jar is responsible for interacting with sso-server.

At this point, I believe you have a deeper understanding of "how to customize yaml file management api and generate a complete program based on yaml file". You might as well do it in practice. Here is the website, more related content can enter the relevant channels to inquire, follow us, continue to learn!

Welcome to subscribe "Shulou Technology Information " to get latest news, interesting things and hot topics in the IT industry, and controls the hottest and latest Internet news, technology news and IT industry trends.