Api documentation.

[vorticalbox]

At work I am trying to move the company towards actually documenting and testing our software, as such I'm am looking for a solution for writing api documentation.

 

Currently. As we are a small, everyone has their own little projects but as our team growing it's becoming more import to document thevend points in a central location that everyone can quickly see and know how to use the service.

 

I have thought about maybe using a wiki such as https://wiki.js.org and get the team to follow a mark down template to document their apis.

 

Other options floating around is sharepoint as we have a 365 subscription.

 

Basically what do you do to document apis? 

[0x21]

https://swagger.io/tools/open-source/ if RESTful.

[vorticalbox]

35 minutes ago, mshaugh said:

https://swagger.io/tools/open-source/ if RESTful.

I've used this before, I will try the teams first and then ask for the enterprise if it works well.

[Guest]

When my mom worked for hitachi or IBM (forget which) she just wrote a documentation in whatever word processor. 

 

Personally i like google docs but I’ve never worked at a company competent enough to write a documentation. When I worked on a school project, we used google docs. The word version. 

[vorticalbox]

1 hour ago, fpo said:

When my mom worked for hitachi or IBM (forget which) she just wrote a documentation in whatever word processor. 

 

Personally i like google docs but I’ve never worked at a company competent enough to write a documentation. When I worked on a school project, we used google docs. The word version. 

I'm thinking for polices to use share point as we have a 365 subscription.

[AgtLucas]

For API docs, you could check one of these options:

https://github.com/Kikobeats/awesome-api#documentation

 

Or https://docusaurus.io

 

Swagger is very used as well.

[Guest]

3 hours ago, vorticalbox said:

I'm thinking for polices to use share point as we have a 365 subscription.

Is it basically Microsoft word where everyone can type at the same time? 

I like docs cuz of that (& you can comment) but it’s best to stick to one ecosystem as you suggested.