recently need to tidy up the company"s interface
is there a good tool to write this document
recently need to tidy up the company"s interface
is there a good tool to write this document
take a look at Doxygen, which automatically generates API documents for HTML (and other optional formats) based on comments in a specific format in your code.
supports multiple languages, simple and easy to use, but only if your project code is fully annotated!
the home page of the tool is as follows:
http://www.doxygen.nl/
Refer to the official explanation for the specific content.
depends on the development language used by your company.
For example, if you use Java, use Javadoc;
.
If you are using Javascript, use jsdoc;
If you are using Ruby, use RDoc;
If you are using Obj-c, use appledoc;
Wait.
of course, the most important thing is whether the comments related to the original interface have been properly written
doxmate, document in markdown
has anyone ever used RAML
swagger is the best I've ever used, but it's troublesome to write related json and doesn't want to be integrated into the code. However, the json corresponding to swagger-ui can be written in an online form on the website (www.sosoapi.com). It is easy to edit and can be previewed, imported and exported online. It is very convenient for
Ali's rap, or eoapi
you can use Markdown to write documents. Refer to my open source project recommend that you try easy documentation very professional interface documentation platform
Previous: How to use http persistent connection + stream to refresh data in real time?
Next: How to deal with complex and time-consuming business logic in Netty?
Why did spring fail to automatically match fields? Wechat s front end reads as follows: Java: ...
I can understand if the server sets the ip, but why does setting the application type to the browser still require whitelist restrictions on the domain name? at this time, the request for Baidu Map API should come from the customer s browser, that is,...
default value 2018 04 16, 2018 04 17, 2018 04 18, 2018 04 19, 2018 04 20, 2018 04 21, 2018 04 28 when I deal with it on the other side how to convert it to array and send json to the specified http? Using curl $data = array( "date" =&g...
suppose I have the following HTTP methods router.post( ,(req,res,next)=>{}) router.get( ,(req,res,next)=>{}) order router.get( :orderId ,(req,res,next)=>{}) order router.patch( :orderId ,(req,res,next)=>{}) order router.d...
var data = { query: , page_size: 20, radius: 2000 , output: json , ak: av0gRXBETn44ByDpMgYhj95P9nACGns9 }; var map = new BMap.Map("container"); m...
the first time you use "ASP.NET MVC4 WebAPI " to develop a project, you only need to use WebAPI because the front end invokes the rendering directly by HTML+Ajax. < H2 > doubt 1 < H2 > what elegant posture do the great gods use to avoid the growth ...
I see an example when he deletes the id is put in the url, as follows router.delete( :id ,function(req,res){}) but you do put it in req.body when you update it, as follows router.update( ,function(req,res){ req.body._id }) Why is this?...
want to check suppose I use php curl to connect http request, to the database of the opposite party and use json_decode first and then print out the json results <?foreach ($region_get_all->regions as $key) { echo $key->{ manager-id }; .....
call Baidu Map ip to obtain the location API, and the data has been returned successfully, but a cross-domain error has been reported, resulting in the callback method unable to be executed. Ask for advice Failed to load https: api.map.baidu.com ...
Hello, everyone. I now use com.offbytwo.jenkins for Jenkins-related operations. I need a user name and password or token, when creating a jenkins Service. Because it is not convenient to save the user s password, I want to operate through token. In addi...
use the positioning system of Baidu Maps to obtain the current longitude and latitude information, and you can only get the street level. but when using Baidu map location, the web version will also give a most matching address, for example, you are now...
how to debug apicloud studio on Google browser (mainly debug htmlcss) ...
Hello everyone, the latest project needs to be docked with the interface of a mall, simply to call their various interfaces, such as ordering, commodity inquiry, freight and so on. in accordance with the previous practice, in order to facilitate stati...
I now need to write an api is a specific account where other people can upload videos to my server , but I don t know how to start? The concept of is that the counterpart can send the film to me through enctype= "multipart form-data " . I will sen...
Hello, seniors! recently I encountered some puzzling problems in playing api, but I still couldn t find a solution after climbing the article, so I sent a post to ask . when I load a web page, I trigger an api,api that brings xxx to the backend in h...
apidoc this plug-in does not allow the use of Chinese in the @ apiGroup block. If it has Chinese, it will use "_ _ " instead. wants to know what else can be done to make @ apiGroup use Chinese besides being defined in @ apiDefine. ** * @api {po...
echarts Silver Earth Baidu Map, want to use map coordinates to locate the pie chart, but the actual effect is still displayed according to pixel positioning. All the pie charts overlap option: const option = { name: pie-map , bmap: { ...
I wrote an upload photo api for ios to use: if($_FILES[ cover ][ size ] != ){ do.... }else{ echo error! ; } The counterpart bit is also cover and post matching , but it just happens to be error! can t catch the file size of th...
I fork a project from github, which is a WeChat Mini Programs who calls Douban API to obtain data. When I fork to the local area, I find that it cannot be opened normally. Network returns 403 because there is no Douban api permission. I just went to Dou...
use swagger 2.0 to generate documents, and you now expect response to return multiple instances. However, the official examples are all for one schema instance, so ask for help on how to write the information that returns multiple instances. ...