Azure DevOps API Documentation

%3CLINGO-SUB%20id%3D%22lingo-sub-1177845%22%20slang%3D%22en-US%22%3EAzure%20DevOps%20API%20Documentation%3C%2FLINGO-SUB%3E%3CLINGO-BODY%20id%3D%22lingo-body-1177845%22%20slang%3D%22en-US%22%3E%3CP%3EI%20am%20starting%20a%20new%20project%20of%20documenting%20APIs%20for%20our%20clients.%20And%20I'm%20not%20sure%20where%20to%20start%20in%20Azure.%20Can%20I%20document%20API%20without%20knowing%20code%3F%20Can%20you%20point%20me%20the%20right%20direction%20on%20getting%20started%20on%20this%20project%20as%20in%3A%20a%20template%20for%20documenting%20APIs%3F%3C%2FP%3E%3C%2FLINGO-BODY%3E%3CLINGO-SUB%20id%3D%22lingo-sub-1178232%22%20slang%3D%22en-US%22%3ERe%3A%20Azure%20DevOps%20API%20Documentation%3C%2FLINGO-SUB%3E%3CLINGO-BODY%20id%3D%22lingo-body-1178232%22%20slang%3D%22en-US%22%3E%3CP%3EHi%20%3CA%20href%3D%22https%3A%2F%2Ftechcommunity.microsoft.com%2Ft5%2Fuser%2Fviewprofilepage%2Fuser-id%2F560870%22%20target%3D%22_blank%22%3E%40hberg2019%3C%2FA%3E%26nbsp%3B!%20I%20don't%20know%20if%20there%20is%20a%20better%20or%20more%20sophisticated%20way%20to%20document%20API%20in%20Azure%20DevOps.%20But%20I've%20been%20using%20the%20Wiki%20feature%20under%20the%20Overview%20section%20of%20Azure%20DevOps%20portal%20for%20documenting%20API%20endpoints...%3C%2FP%3E%3CP%3E%26nbsp%3B%3C%2FP%3E%3CP%3EEven%20if%20you%20are%20not%20familiar%20with%20the%20API%20code%2C%20as%20long%20as%20it%20is%20within%20the%20selected%20repository%2C%20it%20would%20plot%20a%20Wiki%20page%20each%20code%20files%20of%20the%20API.%20You%20can%20search%20for%20tips%20and%20techniques%20on%20how%20to%20document%20an%20API%20through%20that%20feature%20(and%20using%20Markdown%20language).%26nbsp%3B%3C%2FP%3E%3CP%3E%26nbsp%3B%3C%2FP%3E%3CP%3EI've%20attached%20a%20screen-shot%20as%20a%20guide%20for%20you%20to%20locate%20the%20Wiki%20feature.%3C%2FP%3E%3C%2FLINGO-BODY%3E
Occasional Visitor

I am starting a new project of documenting APIs for our clients. And I'm not sure where to start in Azure. Can I document API without knowing code? Can you point me the right direction on getting started on this project as in: a template for documenting APIs?

1 Reply

Hi @hberg2019 ! I don't know if there is a better or more sophisticated way to document API in Azure DevOps. But I've been using the Wiki feature under the Overview section of Azure DevOps portal for documenting API endpoints...

 

Even if you are not familiar with the API code, as long as it is within the selected repository, it would plot a Wiki page each code files of the API. You can search for tips and techniques on how to document an API through that feature (and using Markdown language). 

 

I've attached a screen-shot as a guide for you to locate the Wiki feature.