Skip to content

Latest commit

 

History

History
27 lines (22 loc) · 2.25 KB

README.md

File metadata and controls

27 lines (22 loc) · 2.25 KB

OpenAPIClient

OpenAPI generator AND client for Elixir.


Based on/uses the great package open-api-generator and inspired by open-api-github (both projects created by AJ Foster)

Differences from open-api-generator:

  • All generated identifiers (parameter/field names and enum options) have "Elixir's look-and-feel" (converted using Macro.underscore/1) by default (custom renaming rules can be set through configuration). For example: merchantPaymInfo -> merchant_paym_info, EXTRA_CHARGE -> extra_charge
  • Generated enum options can be configured as strict - not allowing other values. Feature disabled by default
  • Required query and header parameters used as operation function arguments when no defaults were configured for them
  • Added generation for handling parameters (path, query and header) with defaults
  • Added docstring generation for path and header parameters. Docstring now has two blocks ## Arguments for required parameters without defaults and ## Options for all the other parameters
  • Added @enforce_keys for required schema fields
  • "Fixed" processing of 2XX response status codes and provided a way to set "successiveness" for default response status codes
  • Added client module and pipeline (based on pluggable) to use generated operation. At this point library provides only a naive pipeline implementation for httpoison HTTP client. Library users can implement their own use it as a default one. Additionally library provides a way to configure decoders and encoders for different Content-Types
  • Generated operation tests based on spec examples

TODOs