Skip to content
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.

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

chore: Add API Documentation-Driven Design to API documentation #2682

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
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
Prev Previous commit
feat(glossary): Update API Documentation-Driven Design.mdx
p6l-richard committed Nov 26, 2024
commit 0080ad4e9613346a192cca4e87aeb62fb12d3922
Original file line number Diff line number Diff line change
@@ -45,7 +45,7 @@ faq:
answer: API Documentation-Driven Design has several benefits. First, it ensures that the API is user-centric because it forces developers to think about how the API will be used before they start coding. Second, it can help to identify potential issues or gaps in the API's design early in the development process, which can save time and resources. Third, it can make the development process more efficient by providing a clear roadmap for developers to follow. Finally, it can improve the quality of the API documentation, as the documentation is considered an integral part of the development process, not an afterthought.
- question: How to implement API Documentation-Driven Design?
answer: Implementing API Documentation-Driven Design involves several steps. First, you need to define the functionality of your API and write detailed documentation that includes information about the API's endpoints, request/response formats, and error codes. Tools like Swagger or Apiary can be used to create this documentation. Once the documentation is complete, you can use it as a guide to develop your API. As you develop the API, you should continuously update the documentation to reflect any changes or additions to the API. Finally, once the API is complete, you should review the documentation to ensure it accurately represents the API's functionality.
updatedAt: 2024-11-26T13:07:28.000Z
updatedAt: 2024-11-26T13:08:39.000Z
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Update the timestamp to the current date

The updatedAt field is set to November 26, 2024, which is a future date. This should be set to the current date or removed to let the system handle it automatically.

-updatedAt: 2024-11-26T13:08:39.000Z
+updatedAt: 2023-11-26T13:08:39.000Z

Committable suggestion skipped: line range outside the PR's diff.

slug: api-documentation-driven-design
---