Serializes OpenAPI parameter objects.
npm install @himenon/openapi-parameter-formatterA 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
``ts
import { PathParameter } from "@himenon/openapi-parameter-formatter";
PathParameter.generate("color", {
value: {
R: 100,
G: 200,
B: 150,
},
style: "label",
explode: true,
});
`
`ts
import { QueryParameter } from "@himenon/openapi-parameter-formatter";
QueryParameter.generate("color", {
value: {
R: "#100",
G: "#200",
B: "#150",
},
style: "form",
explode: true,
});
// R=%23100&G=%23200&B=%23150
`
`ts
import { QueryParameter } from "@himenon/openapi-parameter-formatter";
QueryParameter.generate("color", {
value: ["#blue", "#black", "#brown"],
style: "spaceDelimited",
explode: false,
});
// color=%23blue%20%23black%20%23brown
`
`ts
import { QueryParameter } from "@himenon/openapi-parameter-formatter";
QueryParameter.generate("color", {
value: ["#blue", "#black", "#brown"],
style: "pipeDelimited",
explode: false,
});
// color=%23blue%7C%23black%7C%23brown
`
`ts
import { QueryParameter } from "@himenon/openapi-parameter-formatter";
QueryParameter.generate("color", {
value: {
R: 100,
G: 200,
B: 150,
},
style: "deepObject",
explode: true,
});
// color%5BR%5D=100&color%5BG%5D=200&color%5BB%5D=150
`
`ts
import { HeaderParameter } from "@himenon/openapi-parameter-formatter";
HeaderParameter.generate("color", {
value: ["blue", "black", "brown"],
style: "simple",
explode: false,
});
// "blue,black,brown"
`
`ts
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"
``