jonalm/openapi.jl

OpenAPI helper and code generator for Julia

OpenAPI

This is the Julia library needed along with code generated by the OpenAPI generator to help define, produce and consume OpenAPI interfaces.

Quick Guide

• Create an API specification. Check out OpenAPI-Spec for specification syntax and examples.
• Use instructions provided for the Julia OpenAPI code generator plugin to generate Julia code.
• Client:
  • Use the generated client in Julia directly to invoke APIs
• Server:
  • Provide code to handle API invocations on the server side by implementing the Julia methods corresponding to API stubs.
  • Start a server using HTTP.jl and register the generated request handlers.

Examples

The Petstore is a common example that most OpenAPI implementations use to test and demonstrate. Clients and servers generated from both version 2 and 3 specifications are included in this repo.

• Petstore v2:
  • Client: docs, implementation
  • Server: docs, implementation
• Petstore v3:
  • Client: docs, implementation
  • Server: docs, implementation