OpenAPI specs across feature folders #443
harikrishnan83
started this conversation in
Show and tell
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
Hi all 👋,
It is great to see that Spec Kit generates an OpenAPI spec for each feature, super helpful for driving development. One challenge I have noticed though is that these specs end up fragmented across different folders (the OpenAPI specs are under each spec folders like 001-product-listing-page, 002-product-display-page, etc.). This also leads to duplication.
In my frontend–backend apps, I have been experimenting with keeping a unified OpenAPI spec at the repo root as the API contract. This helps me check backward compatibility as part of
/planon the OpenAPI spec to make sure new features do not break existing features. Excerpt from myplan-template.mdHere is my article on this - https://www.linkedin.com/pulse/spec-driven-development-beyond-first-feature-api-design-krishnan--lbyec. Would love to hear your thoughts and feedback!
Curious if others have run into the same, do you stick with fragmented per-feature specs, or do you consolidate them into a single spec over time?
UPDATE: More detailed walkthrough in this article - https://www.linkedin.com/pulse/spec-driven-development-api-design-first-github-kit-mcp-krishnan--ywx6c.
Beta Was this translation helpful? Give feedback.
All reactions