openapi3: OpenAPI 3.0 data model
This library is intended to be used for decoding and encoding OpenAPI 3.0 API specifications as well as manipulating them.
The original OpenAPI 3.0 specification is available at http://swagger.io/specification/.
[Skip to Readme]
Modules
[Index] [Quick Jump]
Downloads
- openapi3-3.2.4.tar.gz [browse] (Cabal source package)
- Package description (revised from the package)
Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.
Maintainer's Corner
For package maintainers and hackage trustees
Candidates
| Versions [RSS] | 3.0.0, 3.0.0.1, 3.0.1.0, 3.0.2.0, 3.1.0, 3.2.0, 3.2.1, 3.2.2, 3.2.3, 3.2.4 (info) |
|---|---|
| Change log | CHANGELOG.md |
| Dependencies | aeson (>=1.4.2.0 && <1.6 || >=2.0.1.0 && <2.3), aeson-pretty (>=0.8.7 && <0.9), base (>=4.11.1.0 && <4.20), base-compat-batteries (>=0.11.1 && <0.14), bytestring (>=0.10.8.2 && <0.13), containers (>=0.5.11.0 && <0.8), cookie (>=0.4.3 && <0.6), generics-sop (>=0.5.1.0 && <0.6), hashable (>=1.2.7.0 && <1.5), http-media (>=0.8.0.0 && <0.9), insert-ordered-containers (>=0.2.3 && <0.3), lens (>=4.16.1 && <5.4), mtl (>=2.2.2 && <2.4), openapi3, optics-core (>=0.2 && <0.5), optics-th (>=0.2 && <0.5), QuickCheck (>=2.10.1 && <2.16), scientific (>=0.3.6.2 && <0.4), template-haskell (>=2.13.0.0 && <2.22), text (>=1.2.3.1 && <2.2), time (>=1.8.0.2 && <1.14), transformers (>=0.5.5.0 && <0.7), unordered-containers (>=0.2.9.0 && <0.3), uuid-types (>=1.0.3 && <1.1), vector (>=0.12.0.1 && <0.14) [details] |
| Tested with | ghc ==8.4.4 || ==8.6.5 || ==8.8.4 || ==8.10.7 || ==9.0.2 || ==9.2.8 || ==9.4.8 || ==9.6.3 || ==9.8.1 |
| License | BSD-3-Clause |
| Copyright | (c) 2015-2016, GetShopTV, (c) 2020, Biocad |
| Author | Nickolay Kudasov, Maxim Koltsov |
| Maintainer | nickolay@getshoptv.com, kolmax94@gmail.com |
| Revised | Revision 2 made by maksbotan at 2024-05-23T15:49:39Z |
| Category | Web, Swagger, OpenApi |
| Home page | https://github.com/biocad/openapi3 |
| Bug tracker | https://github.com/biocad/openapi3/issues |
| Source repo | head: git clone https://github.com/biocad/openapi3.git |
| Uploaded | by maksbotan at 2023-11-20T10:54:59Z |
| Distributions | LTSHaskell:3.2.4, NixOS:3.2.4, Stackage:3.2.4 |
| Reverse Dependencies | 25 direct, 9 indirect [details] |
| Executables | example |
| Downloads | 9568 total (126 in the last 30 days) |
| Rating | (no votes yet) [estimated by Bayesian average] |
| Your Rating | |
| Status | Docs available [build log] Last success reported on 2023-11-20 [all 1 reports] |
Readme for openapi3-3.2.4
[back to package description]OpenApi 3
OpenAPI 3.0 data model.
The original OpenAPI 3.0 specification is available at http://swagger.io/specification/.
This package is heavily based on excellent work on Swagger 2.0 at https://github.com/GetShopTV/swagger2.
Usage
This library is intended to be used for decoding and encoding OpenApi 3.0.3 specifications as well as manipulating them.
Please refer to haddock documentation.
Some examples can be found in examples/ directory.
Trying out
All generated swagger specifications can be interactively viewed on Swagger Editor.
Ready-to-use specification can be served as JSON and interactive API documentation can be displayed using Swagger UI.
Many Swagger tools, including server and client code generation for many languages, can be found on Swagger's Tools and Integrations page.
Contributing
We are happy to receive bug reports, fixes, documentation enhancements, and other improvements.
Please report bugs via the github issue tracker.
GetShopTV Team
Biocad Team