@himenon/openapi-parameter-formatter

@himenon/openapi-parameter-formatter

A library that serializes OpenAPI parameter objects. It is implemented according to the following style definition.

• https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md#style-examples

Usage

import { PathParameter } from "@himenon/openapi-parameter-formatter";

PathParameter.generate("color", {
  value: {
    R: 100,
    G: 200,
    B: 150,
  },
  style: "label",
  explode: true,
});

import { QueryParameter } from "@himenon/openapi-parameter-formatter";

QueryParameter.generate("color", {
  value: {
    R: 100,
    G: 200,
    B: 150,
  },
  style: "deepObject",
  explode: true,
});
// color[R]=100&color[G]=200&color[B]=150

import { HeaderParameter } from "@himenon/openapi-parameter-formatter";

HeaderParameter.generate("color", {
  value: ["blue", "black", "brown"],
  style: "simple",
  explode: false,
});
// "blue,black,brown"

import { CookieParameter } from "@himenon/openapi-parameter-formatter";

CookieParameter.generate("color", {
  value: ["blue", "black", "brown"],
  style: "form",
  explode: false,
});
// "color=R,100,G,200,B,150"

LICENCE

@himenon/openapi-parameter-formatter・MIT

Changelog

0.2.2 (2021-01-14)

Bug Fixes

• generate nest object keys (#3) (63abf31)

<a name="0.2.1"></a>