Add OpenAPI specification for the Hacker News REST API #33
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
jamietanna
reviewed
Aug 17, 2023
|
@jamietanna it is not documented, and it is hard to say for sure for some of the fields. IDs should be required for sure |
|
Also Mock API specification created as a part of my blog post demonstrating creation of Mock API specifications in WireMock and WireMock Cloud: wiremock/api-template-library#15 |
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.
This pull request adds OpenAPI specification for the Hacker News API, as documented in the README file. This OpenAPI specification can be used to serve the documentation on the website, to generate client code and to create various API mocks for the integration tests.
In fact, I am currently doing the latter with WireMock and its SaaS edition WireMock Cloud, to demonstrate the templates feature we rolled out in WireMock a while ago. Initially I created the specification for just one request, but then decided that it would be nice to finalize it and to contribute back to the project
I used the most recent version of the specification
Feedback is welcome!
References