Skip to content

XS ◾ Mention Scalar as an API documentation tool #11621

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tiagov8 merged 1 commit into from
Jan 12, 2026
Merged

XS ◾ Mention Scalar as an API documentation tool #11621

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 19 additions & 18 deletions public/uploads/rules/do-you-document-your-webapi/rule.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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: [email protected]
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: [email protected]
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)).

<endIntro />

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**
**✅ Swagger gives you a nice UI automatically generated on top of your WebAPI methods**
Loading