API Design-first Article #306
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for bump-content-hub ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Thanks @philsturgeon ! It needed an update indeed. I would love if we can still make it as "agnostic" as possible (not stick to only OpenAPI). Also, it would be great to give guidance on a good API Design-first process, such as James' ADDR. |
|
@ChristopheDujarric lmk if this is what you had in mind. I can get stuck into ADDR more too if you like, but thats mainly just giving a name to the concepts being described here. |
philsturgeon
force-pushed
the
design-first
branch
from
1de2fd8 to
a02c289
Compare
|
@philsturgeon thank you for the update, this looks great! Can you please check about the failing test? |
|
@ChristopheDujarric fixed! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@ChristopheDujarric the previous guide was good, but it conflated API Design-first and API-first design.
One of the most confusing things in the world of APIs is that these are two fundamentally different concepts...
I have focused entirely on API Design-first here, but would be happy to take a quick stab at what API-first means for the sake of SEO and telling a complete story. It could be a paragraph.
Other than that, this could definitely be better, go in deeper, have more diagrams, etc. Just wanted to fire it over as I'm on 4 hours with it already and want to make sure I get the right direction.