docs: oas (#197)
Adds OpenAPI specification of Storefront and Admin APIs. Updates docs project.
This commit is contained in:
59
scripts/build-openapi.js
Executable file
59
scripts/build-openapi.js
Executable file
@@ -0,0 +1,59 @@
|
||||
#!/usr/bin/env node
|
||||
|
||||
const fs = require("fs");
|
||||
const OAS = require("oas-normalize");
|
||||
const swaggerInline = require("swagger-inline");
|
||||
|
||||
// Storefront API
|
||||
swaggerInline(
|
||||
["./packages/medusa/src/models", "./packages/medusa/src/api/routes/store"],
|
||||
{
|
||||
base: "./docs/api/store-spec3-base.json",
|
||||
}
|
||||
).then((gen) => {
|
||||
const oas = new OAS(gen);
|
||||
oas.validate((err, genObj) => {
|
||||
if (err) {
|
||||
console.error(err);
|
||||
return;
|
||||
}
|
||||
fs.writeFileSync("./docs/api/store-spec3.json", JSON.stringify(genObj));
|
||||
}, true);
|
||||
});
|
||||
|
||||
swaggerInline(
|
||||
["./packages/medusa/src/models", "./packages/medusa/src/api/routes/store"],
|
||||
{
|
||||
base: "./docs/api/store-spec3-base.json",
|
||||
format: "yaml",
|
||||
}
|
||||
).then((gen) => {
|
||||
fs.writeFileSync("./docs/api/store-spec3.yaml", gen);
|
||||
});
|
||||
|
||||
// Admin API
|
||||
swaggerInline(
|
||||
["./packages/medusa/src/models", "./packages/medusa/src/api/routes/admin"],
|
||||
{
|
||||
base: "./docs/api/admin-spec3-base.json",
|
||||
}
|
||||
).then((gen) => {
|
||||
const oas = new OAS(gen);
|
||||
oas.validate((err, genObj) => {
|
||||
if (err) {
|
||||
console.error(err);
|
||||
return;
|
||||
}
|
||||
fs.writeFileSync("./docs/api/admin-spec3.json", JSON.stringify(genObj));
|
||||
}, true);
|
||||
});
|
||||
|
||||
swaggerInline(
|
||||
["./packages/medusa/src/models", "./packages/medusa/src/api/routes/admin"],
|
||||
{
|
||||
base: "./docs/api/admin-spec3-base.json",
|
||||
format: "yaml",
|
||||
}
|
||||
).then((gen) => {
|
||||
fs.writeFileSync("./docs/api/admin-spec3.yaml", gen);
|
||||
});
|
||||
19
scripts/generate-fixtures.sh
Executable file
19
scripts/generate-fixtures.sh
Executable file
@@ -0,0 +1,19 @@
|
||||
#!/bin/bash
|
||||
|
||||
FIXTURE_PATTERN=$1
|
||||
|
||||
lerna run build
|
||||
|
||||
cd docs-util/fixture-gen
|
||||
|
||||
yarn
|
||||
yarn link @medusajs/medusa medusa-interfaces
|
||||
|
||||
cd ../..
|
||||
|
||||
if [ "$FIXTURE_PATTERN" ]; then
|
||||
yarn test:fixtures -t $FIXTURE_PATTERN
|
||||
else
|
||||
yarn test:fixtures
|
||||
fi
|
||||
|
||||
Reference in New Issue
Block a user