Create an easy-to-use and beautiful API document in 5 minutes

Time:2022-11-24

Create an easy-to-use and beautiful API document in 5 minutes

️ Have you ever encountered such a scene?

  • When docking third-party open platform documents, the left hand brushes the interface document to read the API, and the right hand operates the interface debugging tool
  • Want to deliver or provide API documents to third parties after writing the interface, but feel that the document display experience is average? Very tasteless?

foreword

The open interface documents of the early third-party open platforms mainly focus on information display, and the basic information includes request methods, parameter descriptions, return results, and so on. Here we take the enterprise WeChat developer center document as an example

Create an easy-to-use and beautiful API document in 5 minutes

And for a long time, in order to debug the open interface, we are often used to facing the interface document on the left and opening Postman debugging on the right.

And last week, the WeChat open platform was launcheddebugging tool,WillDocumentation and in-circuit debuggingAll in one. In a sense, it breaks the original singleinformation displaydominant situation

Create an easy-to-use and beautiful API document in 5 minutes

The advantage of this is that you can reach the debugging tool table with one click through the interface document

️ Then if other open platforms areSupport online debugging, Is the efficiency raised by a level?

From the above, we can see that WeChat actually provides a debugging tool to empower the original interface documents

But for other platforms, if you want to save time and effort, you can also develop a setInterface documentation system with online debugging

ThatApifoxwill be your most satisfying choice

Official website address:apifox.cn

Apifox integrates in the interface documentdebug functionCode generation onlineand many more

Create an easy-to-use and beautiful API document in 5 minutes

The picture above is the interface management Saas service providerApifoxRelease ofApihub(Open API sharing platform) Among them, the open documents of WeChat Enterprise.

Through online debugging of documents, the efficiency of developers connecting to open platform APIs is further improved.

The platform is currently aggregatedMost mainstream third-party open APIs

Create an easy-to-use and beautiful API document in 5 minutes

In other words throughApifox EmpowermentofOpen API DocumentationAll have online debugging and code generation. include features

Support online debugging: Click the request to display the debugging results in real time, and the returned information is clear at a glance

Automatically generate code snippets: Supports automatic generation of code snippets, saving time and effort and making it more efficient

️ As a personal developer, can you publish such a good-looking and easy-to-use API document through Apifox?

Yes, 5 minutes to teach you to get it done!

Apifox publishes API documentation

First, we find in the online sharing Tab of Apifox softwarenew sharebutton

Create an easy-to-use and beautiful API document in 5 minutes

Then select the sharing attributes (document language, access password, environment selection, sharing scope, etc.) in the pop-up window of the new share. Here we take the pet store Demo as an example.

Create an easy-to-use and beautiful API document in 5 minutes

After saving successfully, move the mouse to the newly created share in the share list, and click the open link that appears on the interface

Create an easy-to-use and beautiful API document in 5 minutes

Open Apifox to generate the interface document as follows, and also support online debugging!

Create an easy-to-use and beautiful API document in 5 minutes

️ Can the generated interface document be further customized under “decoration”?

Create an easy-to-use and beautiful API document in 5 minutes
Yes, the document customization areas currently provided by Apifox are

  • top navigation menu
  • Ribbon on the right side of the top navigation
  • Banner area at the bottom of document content

It can be defined under the release document column

Create an easy-to-use and beautiful API document in 5 minutes

It is also mentioned in the official website document later that there will be more open areas for us to DIY!

Not only that, but you can also customize your domain name. Documents published through Apifox currently use URLs in the format of xxx.apifox.cn, but you can point your domain name directly to the documents you publish

  • 1. inPublish Document > Publish SettingsSet your own custom domain name in the panel

Create an easy-to-use and beautiful API document in 5 minutes

  • 2. Add ApifoxCNAMEGo to the configuration center of your domain name vendor

Create an easy-to-use and beautiful API document in 5 minutes

Finally, publish through your customized interface document, or you can apply for publishing to the above-mentionedAPI Hubmiddle

Create an easy-to-use and beautiful API document in 5 minutes

After completing the above operations, you will get an easy-to-use and beautiful API document

  • API documentation supports online debugging
  • The domain name is customized by you
  • Document customization area is your DIY

Share with your friends to save face!

Official address:apifox.cn

at last

The API documentation function is justApifoxThe tip of the iceberg of powerful features also providesAPI debuggingAPI MockAPI automation testingand other functions

Create an easy-to-use and beautiful API document in 5 minutes