{"Status":true,"Message":"","Response":{"post":{"postuid":"df3985af-dc8c-424b-bd5c-9ed26cc516ce","tenantuid":"d8b744fc-2e70-4089-bb80-dd1d08f6c7b2","projectuid":"fc6490ac-7527-4f49-b06e-46f701280e85","title":"API Documentation Guide","slug":"article/api-documentation-guide-1","html":"\u003Cp\u003EHelpGuides was built for technical teams that need to publish end user documentation. However, it also supports publishing API documentation for REST-based APIs.\u003C/p\u003E\u003Ch2 id=\u0022documenting_an_api_end_point\u0022\u003EDocumenting an API end point\u003C/h2\u003E\u003Cp\u003EWhen creating documentation for an API end point you can use the article type to format content as a REST end point in your user documentation.\u003C/p\u003E\u003Cp\u003EFor example, \u003Ca href=\u0022https://dev.dailystory.com\u0022\u003EDailyStory\u0027s REST API documentation\u003C/a\u003E:\u003C/p\u003E\u003Cimg class=\u0022lazy-load\u0022 data-width=\u00221418\u0022 data-height=\u0022785\u0022 data-src=\u0022https://graffiti-auf7e6dwhxhcbwek.z03.azurefd.net/d8b744fc-2e70-4089-bb80-dd1d08f6c7b2/fc6490ac-7527-4f49-b06e-46f701280e85/78709455-c5a6-4811-a7e8-942a9fbecd0a.png?v=999246946\u0022 style=\u0022\u0022 alt=\u0022\u0022/\u003E\u003Cp\u003EWhen selecting the article type for a new document select \u003Cb\u003EAPI Reference\u003C/b\u003E. This will add the ability to specify the HTTP verb, e.g. GET, PUT, POST, etc., as well as the endpoint\u0027s URL.\u003C/p\u003E\u003Cp\u003EThe HTTP verb is shown in the lefthand menu and is shown when viewing the documentation.\u003C/p\u003E\u003Ch2 id=\u0022rest_api_widget\u0022\u003EREST API widget\u003C/h2\u003E\u003Cp\u003EThe REST API widget is a special widget only available for articles that are set to type \u003Cb\u003EAPI Reference\u003C/b\u003E. This widget examines properties of the article, such as the HTPP verb and path to render options for documenting a REST end point.\u003C/p\u003E","publish_status":0,"post_type":"Article","authoruid":"3dde8c16-763a-4a2b-ae0b-1d8c50c62e3d","author":{"authoruid":"3dde8c16-763a-4a2b-ae0b-1d8c50c62e3d"},"featured_image_updating":false,"meta_description":"HelpGuides lets technical teams publish user and REST API documentation with features for formatting endpoints, HTTP verbs, and a REST API widget.","display_toc":true,"has_workingcopy":false,"allow_indexing":true,"total_views":1,"date_published":"2026-10-04T21:44:54.637","date_updated":"2026-10-04T21:44:55.253","date_created":"2025-09-27T17:59:59.82"}}}