API documents are simple and beautiful. It only needs three steps to open

Connect the world , Don't be vague

API When it first appeared, it was usually used as a library for the operating system , And almost all of them run in the local system . To 2000 s , They are out of the local operating environment , Become an important technology for remote interactive data . Today, ,API Not just a technical connection , It has also become a business connection . By opening API, Individuals or businesses can open the door to freedom , To the customer 、 Partners provide digital products and services .API Gateway as management API The platform of , Is also moving towards API Developers provide more 、 Complete service direction forward . In the near future , Tencent cloud API Gateway in existing API Based on the full life cycle management capability , union CODING API Documentation product team , For developers API Document generation tool , Based on this tool, developers can publish on demand API file .

Tencent cloud API gateway （ hereinafter referred to as API gateway ） Tencent cloud Severless The team launched API hosted services , Can provide API Complete lifecycle management , Including the creation of 、 maintain 、 Release 、 function 、 Offline, etc . You can use it. API The gateway encapsulates its own business , Put your data 、 Business logic or functions are opened up safely and reliably , To realize its own system integration 、 And business connections with partners .

Precise and concise API Documentation can reduce API The complexity of collaboration , To give API The caller is more intuitive API Information , Before it's solved API Inefficiency caused by word of mouth , Simplify and accelerate API Integration process . For example, in the common front and back-end development collaboration scenarios , Through an interface document , You can achieve front and back-end parallel development ： Background developers put API Hosted in API On the gateway , Match well mock server, utilize API Document function API Information is provided to front-end students , To achieve front and rear end separation .API Documentation can solve more than that ：

• If you put API treat as Interface , Then you need to let the user know how to interface with the system , So your API Documentation is the detailed instructions you provide .
• If you put API As contract , Then you need to let the partners know the rules between you in detail , Yours API A document is a complete agreement between the parties .
• If you put API As goods , Then you need to let your customers know how to place an order , Yours API Documentation is the beautiful menu you provide .

Now? , Tencent's cloud API Gateway console , Just three steps to quickly publish your API file .

Three step opening is simple API file

step 1： When you log in 「 Tencent cloud API Gateway console 」 after , Select... In the tools column 「API file 」, You can aim at what you have API Create corresponding documents .

Choose what you want to publish API, Give the rest to CODING API Documentation and API gateway .

step 2： A few sips of hot water , You can see the automatically built API Document links , You can share this link and password with your collaborators anytime, anywhere .

step 3： Get the link and password , Your collaborators can see clearly in the browser 、 concise 、 canonical API file . Three column classic document format , Show at the same time API list 、 API Details and call examples , More in line with developers' reading habits . Proper color highlighting and proper spacing are used to show each API Detailed call description of ： Include URL、Request、Response Information, etc. . once API The interface content has changed （ although API Infrequent change ）, As long as API Click... In the documentation tool 「 to update 」, constant API Document address , Abreast of the times API Document content .

It's easy to use, but it doesn't look good ？

For developers , From one line of code , To a function , To another application 、 One API Documentation or a technical blog , These work results are the business cards of you or your team , We hope your work is not only efficient but also decent .CODING The development team is deeply engaged in API Years of collaboration , It brings about a pleasant experience API file , Just for an immersive reading experience .API The documentation tool is now available in Tencent cloud API The gateway was officially launched and opened for free , API Gateway users can immediately have a new API file .

About CODING

about API Users with more diverse requirements for document functions , You can choose to log in CODING Use more comprehensive API Document management function , Including support OpenAPI / Postman / Apidoc API Description format import document 、 Free choice of open document mode, etc , Start orderly API Document collaboration . not only API file , betake “ Make development easier ” Of CODING, Provides hosting from code 、 Project collaboration 、 Continuous integration 、 Product warehouse 、 Continuous deployment 、 file management /Wiki And so on , Welcome to CODING.NET Learn more about .