Skip to content

Commit

Permalink
Add link to example and guide header details (#298)
Browse files Browse the repository at this point in the history
Co-authored-by: Christophe Dujarric <[email protected]>
  • Loading branch information
ChristopheDujarric and ChristopheDujarric authored Oct 4, 2024
1 parent 584ef80 commit ef34c31
Showing 1 changed file with 5 additions and 1 deletion.
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
title: Writing an OpenAPI Document from the Ground Up
authors: james
excerpt: A step-by-step guide for authoring OpenAPI documents, starting from the essentials and expanding upon the details of your API.
canonical_url: https://bump.sh/blog/openapi-from-ground-up
excerpt: A step-by-step guide for authoring OpenAPI documents, starting from the essentials and expanding upon the details of your API.
date: 2024-10-01
---

Composing an OpenAPI document can be daunting, especially during the early stages of API design. Your API design will need to evolve as you learn more about the problem space. To avoid needing to re-write large portions of your OpenAPI document, [I recommend a phased approach](https://addrprocess.com) to designing and documenting your API. The process starts with a breadth-first approach, capturing the essentials of the API including purpose and scope, then adding high-level operational descriptions. Finally, add more detail as you gain insights and receive feedback, until your OpenAPI document is complete.
Expand Down Expand Up @@ -700,6 +702,8 @@ components:
# ... hidden for readability ...
```

This example is available in the [Bump.sh GitHub repository](https://github.com/bump-sh/examples/blob/main/apis/todo-example-openapi-source.yaml).

### Step 3.5: Review and Validate
- **Objective:** Ensure the accuracy and completeness of the OpenAPI document.
- **Action:** Test each operation using your editor to ensure you have addressed any syntax errors across the entire document.
Expand Down

0 comments on commit ef34c31

Please sign in to comment.