loafle/openapi-generator-original
3
0
Fork 1
mirror of https://github.com/OpenAPITools/openapi-generator.git synced 2025-10-14 08:23:45 +00:00
Code Issues Packages Projects Releases Wiki Activity
openapi-generator-original/samples/client/petstore/ocaml/README.md
William Cheng 20be2decde
Prepare v7.16.0 release (#21794) 
* Revert "v7.15.0 release (#21792)"

This reverts commit 2c816f89cbd6c4670aaf6e3387c88daadae6cbad.

* prepare 7.15.0 release

* update samples
2025-08-22 19:17:23 +08:00

1.0 KiB
Raw Blame History

This is a sample server Petstore server. For this sample, you can use the api key special-key to test the authorization filters.

This OCaml package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Generator version: 7.16.0-SNAPSHOT
  • Build package: org.openapitools.codegen.languages.OCamlClientCodegen

Requirements.

OCaml 5.x

Installation

Please run the following commands to build the package petstore_client:

opam install . --deps-only --with-test
eval $(opam env)
dune build

Getting Started

The generated directory structure is:

  • src/apis: contains several modules, each with several functions. Each function is an API endpoint.
  • src/models: contains several modules. Each module contains:
    • a type t representing an input and/or output schema of the OpenAPI spec
    • a smart constructor create for this type
  • src/support: various modules used by the generated APIs and Models