diff --git a/public/uploads/rules/do-you-document-your-webapi/rule.mdx b/public/uploads/rules/do-you-document-your-webapi/rule.mdx index 258b190f0a0..de94d8a1963 100644 --- a/public/uploads/rules/do-you-document-your-webapi/rule.mdx +++ b/public/uploads/rules/do-you-document-your-webapi/rule.mdx @@ -1,31 +1,32 @@ --- -archivedreason: null +type: rule +title: Do you document your Web API? +uri: do-you-document-your-webapi +categories: + - category: categories/software-engineering/rules-to-better-web-api-rest.mdx authors: -- title: Eric Phan - url: https://ssw.com.au/people/eric-phan -created: 2016-11-07 00:27:13+00:00 + - title: Eric Phan + url: 'https://ssw.com.au/people/eric-phan' +redirects: + - do-you-document-your-web-api +guid: 48786266-4d2c-4eac-a600-f1df57e177db +seoDescription: >- + Documenting your Web API with Swagger provides an automatic UI to explore and + test methods, ensuring seamless integration with your application. +created: 2016-11-07T00:27:13.000Z createdBy: Eric Phan createdByEmail: ericphan@ssw.com.au -guid: 48786266-4d2c-4eac-a600-f1df57e177db -isArchived: false -lastUpdated: 2020-10-23 02:19:37+00:00 +lastUpdated: 2020-10-23T02:19:37.000Z lastUpdatedBy: Matt Goldman lastUpdatedByEmail: MattGoldman@ssw.com.au -redirects: -- do-you-document-your-web-api -seoDescription: Documenting your Web API with Swagger provides an automatic UI to - explore and test methods, ensuring seamless integration with your application. -title: Do you document your Web API? -categories: - - category: categories/software-engineering/rules-to-better-web-api-rest.mdx -type: rule -uri: do-you-document-your-webapi +isArchived: false +archivedreason: null --- -Documenting your WebAPI is important but you don't want to spend a massive amount of time trying to keep documentation up to date. The solution is to use [Swagger](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md)and [Swashbuckle](https://github.com/domaindrivendev/Swashbuckle). +Documenting your WebAPI is important but you don't want to spend a massive amount of time trying to keep documentation up to date. The solution is to use [Scalar](https://scalar.com/) or [Swagger](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md) ([Swashbuckle](https://github.com/domaindrivendev/Swashbuckle)). Implementing Swagger will give you an automatic UI to explore and test your Web API methods. ![](/uploads/rules/do-you-document-your-webapi/document-api-swagger.png) -**✅ Swagger gives you a nice UI automatically generated on top of your WebAPI methods** \ No newline at end of file +**✅ Swagger gives you a nice UI automatically generated on top of your WebAPI methods**