Skip to content

Commit 0b09a78

Browse files
committed
flesh out readme a bit better
1 parent 79e7399 commit 0b09a78

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

README.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,21 @@
1-
# Hacker News API OpenAPI Spec
1+
# Hacker News API -- OpenAPI Spec
22

3-
Simple, typed OpenAPI wrapper to do codegen off of. Based off the original API here: https://github.com/HackerNews/API
3+
Simple OpenAPI spec for the HN API to do strongly typed code generation off of.
44

5-
Spec: https://raw.githubusercontent.com/andenacitelli/hacker-news-api-openapi/main/exports/api.yaml
5+
Spec: https://raw.githubusercontent.com/andenacitelli/hacker-news-api-openapi/main/exports/api.yaml
6+
7+
- Based off the original API here: https://github.com/HackerNews/API
8+
- Built with [zod](https://github.com/colinhacks/zod) schemas and exported to OpenAPI via [@asteasolutions/zod-to-openapi](https://github.com/asteasolutions/zod-to-openapi).
9+
- End result is validated with [Redocly CLI](https://redocly.com/docs/cli) and a few tests that make real HN calls to validate the schemas.
10+
11+
## Contributing
12+
13+
Please raise issues and I'm happy to fix.
14+
15+
## Funding
16+
17+
If you appreciate the work I do, please feel free to buy me a coffee through [GitHub Sponsors](https://github.com/sponsors/andenacitelli) or [Ko-Fi](https://ko-fi.com/andenacitelli).
18+
19+
## License
20+
21+
MIT

0 commit comments

Comments
 (0)