mirror of
https://github.com/LukeHagar/libopenapi.git
synced 2025-12-06 04:20:11 +00:00
87 lines
4.1 KiB
Markdown
87 lines
4.1 KiB
Markdown
<p align="center">
|
|
<img src="libopenapi-logo.png" alt="libopenapi" height="300px" width="450px"/>
|
|
</p>
|
|
|
|
# libopenapi - enterprise grade OpenAPI tools for golang.
|
|
|
|
|
|
|
|
[](https://goreportcard.com/report/github.com/pb33f/libopenapi)
|
|
[](https://codecov.io/gh/pb33f/libopenapi)
|
|
[](https://discord.gg/x7VACVuEGP)
|
|
[](https://pkg.go.dev/github.com/pb33f/libopenapi)
|
|
|
|
libopenapi has full support for Swagger (OpenAPI 2), OpenAPI 3, and OpenAPI 3.1. It can handle the largest and most
|
|
complex specifications you can think of.
|
|
|
|
---
|
|
|
|
## Sponsors & users
|
|
If your company is using `libopenapi`, please considering [supporting this project](https://github.com/sponsors/daveshanley),
|
|
like our _very kind_ sponsors:
|
|
|
|
<a href="https://speakeasyapi.dev/?utm_source=libopenapi+repo&utm_medium=github+sponsorship">
|
|
<picture>
|
|
<source media="(prefers-color-scheme: dark)" srcset=".github/sponsors/speakeasy-github-sponsor-dark.svg">
|
|
<img alt="speakeasy'" src=".github/sponsors/speakeasy-github-sponsor-light.svg">
|
|
</picture>
|
|
</a>
|
|
|
|
[Speakeasy](https://speakeasyapi.dev/?utm_source=libopenapi+repo&utm_medium=github+sponsorship)
|
|
|
|
---
|
|
|
|
`libopenapi` is pretty new, so our list of notable projects that depend on `libopenapi` is small (let me know if you'd like to add your project)
|
|
|
|
- [github.com/daveshanley/vacuum](https://github.com/daveshanley/vacuum) - "The world's fastest and most scalable OpenAPI/Swagger linter/quality tool"
|
|
- [github.com/pb33f/openapi-changes](https://github.com/pb33f/openapi-changes) - "The world's **sexiest** OpenAPI breaking changes detector"
|
|
- [github.com/pb33f/wiretap](https://github.com/pb33f/openapi-changes) - "The world's **coolest** OpenAPI compliance analysis tool"
|
|
- [github.com/danielgtaylor/restish](https://github.com/danielgtaylor/restish) - "Restish is a CLI for interacting with REST-ish HTTP APIs"
|
|
- [github.com/speakeasy-api/speakeasy](https://github.com/speakeasy-api/speakeasy) - "Speakeasy CLI makes validating OpenAPI docs and generating idiomatic SDKs easy!"
|
|
- [github.com/apicat/apicat](https://github.com/apicat/apicat) - "AI-powered API development tool"
|
|
- Your project here?
|
|
---
|
|
|
|
## Come chat with us
|
|
|
|
Need help? Have a question? Want to share your work? [Join our discord](https://discord.gg/x7VACVuEGP) and
|
|
come say hi!
|
|
|
|
## Check out the `libopenapi-validator`
|
|
|
|
Need to validate requests, responses, parameters or schemas? Use the new
|
|
[libopenapi-validator](https://github.com/pb33f/libopenapi-validator) module.
|
|
|
|
## Documentation
|
|
|
|
See all the documentation at https://pb33f.io/libopenapi/
|
|
|
|
- [Installing libopenapi](https://pb33f.io/libopenapi/installing/)
|
|
- [Using OpenAPI](https://pb33f.io/libopenapi/openapi/)
|
|
- [Using Swagger](https://pb33f.io/libopenapi/swagger/)
|
|
- [The Data Model](https://pb33f.io/libopenapi/model/)
|
|
- [Validation](https://pb33f.io/libopenapi/validation/)
|
|
- [Modifying / Mutating the OpenAPI Model](https://pb33f.io/libopenapi/modifying/)
|
|
- [Mocking / Creating Examples](https://pb33f.io/libopenapi/mocks/)
|
|
- [Using Vendor Extensions](https://pb33f.io/libopenapi/extensions/)
|
|
- [The Index](https://pb33f.io/libopenapi/index/)
|
|
- [The Resolver](https://pb33f.io/libopenapi/resolver/)
|
|
- [Circular References](https://pb33f.io/libopenapi/circular-references/)
|
|
- [What Changed / Diff Engine](https://pb33f.io/libopenapi/what-changed/)
|
|
- [FAQ](https://pb33f.io/libopenapi/faq/)
|
|
- [About libopenapi](https://pb33f.io/libopenapi/about/)
|
|
|
|
> **Read the go docs at [https://pkg.go.dev/github.com/pb33f/libopenapi](https://pkg.go.dev/github.com/pb33f/libopenapi)**
|
|
---
|
|
|
|
### Quick-start tutorial
|
|
|
|
👀 **Get rolling fast using `libopenapi` with the
|
|
[Parsing OpenAPI files using go](https://quobix.com/articles/parsing-openapi-using-go/)** guide 👀
|
|
|
|
> Read the full docs at [https://pkg.go.dev](https://pkg.go.dev/github.com/pb33f/libopenapi)
|
|
|
|
---
|
|
|
|
Logo gopher is modified, originally from [egonelbre](https://github.com/egonelbre/gophers)
|