A beautiful API document generation tool

Preface

It's too late to work overtime today , There is no energy to sort out things to share , Just something ready-made （ Non hydrologic , It really works ）. Sometimes we need a beautiful , Complete and easy to use api Document interface , and Swagger（ I always use this ~） The default style is a little chicken ribs ~~ hey , This tool will come in handy , This is it. ApiFox！

Use

Select usage environment

ApiFox It felt like Postman Domestic enhanced version of , Provides web Version and desktop version , And this desktop version is full platform ~

It is estimated that Electron Such a full platform framework .

Just choose a suitable environment .

Registered account

This doesn't need to be said ~~ It's better to bind wechat , It's more convenient

Create a team

ApiFox The concept involved is still based on the team , That is, whether your team is a bare knuckle commander , still Two-Pizza Team perhaps X-Pizza Team, You have to create a team first , Create good after , The interface document project can be established

Write interface documentation ？

Why add a question mark ？ Because we use ApiFox It's not for you to write your own interface documents from scratch , Of course, if you are willing to do so, it is absolutely no problem . But this can't stand out ApiFox What's great about , Of course, we use it to import the existing interface documents , To achieve the purpose of strengthening and beautifying .

What about here? ,ApiFox Provides a variety of import modes , The first choice is Swagger, Other formats are also supported , Even the format of other interface testing tools （ It's convenient for you to put it in Postman The interface records saved by such tools are migrated ~~ That's a smart kid ）

therefore , Here we will directly put the existing Swagger Just import the document . Note that direct import is supported here json file , Also support passing url Import in the form of , That is, if your interface document has been deployed online , You can go directly through url Point to the json File import to ApiFox in , The whole process , Very silky , For the specific process, see

Official Guide

.

Take a look at the interface comparison before and after import

ordinary Swagger The homepage is like this , It's not ugly , It doesn't look good either , It's not hard to use , It's not easy to use. , The compasses , Common （ Be careful , This is not to belittle swagger,swagger It is also a great framework , I also wrote several introductions before swagger Things that are , Here we just pick out a small part of it ~~ Master duanshui +1）.

Look again. ApiFox Documents generated for us

Does it feel like it has improved several grades in an instant , It can also help you generate access code , Front end colleagues said it was very fragrant .

Last ,ApiFox Functions provided , It's far more than what I mentioned , But the import function I mentioned , It can definitely become a highlight that attracts you to use it ！ I also noticed that many bloggers have made comprehensive introductions ApiFoxle , I feel that what you have written is too comprehensive , There are too many highlights , Maybe it's a low rank like me , Nor used ApiFox For my classmates , It's not very attractive , Maybe even because you write too much, it makes people feel that the learning cost is too high , Just ignore , Cause Amway to fail ~~. But a good product will shine by itself , More experience , Let's go see

Official manual

Well .

Okay , That's about it .