-
Notifications
You must be signed in to change notification settings - Fork 714
Add OpenAPI specification for the Hacker News REST API #33
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
Conversation
@jamietanna
jamietanna
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't see any required blocks in the objects coming back, is that right that every field may be optional?
oleg-nenashev
commented
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
oleg-nenashev
commented
Aug 24, 2023
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
hamiecod
commented
Sep 5, 2025
Why hasn't this been merged?
Uh oh!
There was an error while loading. Please reload this page.
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