openapi-metadata

[kerwanp]

This Pull request brings a new library openapi-metadata. It is a complete rewrite of the original one that has never been released to bring a better developer experience, improved extensibility and a smaller and cleaner codebase.

openapi-metadata makes it easy to generate OpenAPI compliant documents using Typescript decorators. It is intended to be used through specific integrations depending on the backend but can also be used as it is.

Here is an example using express:

import express from "express";
import { generateDocument } from "openapi-metadata";
import { generateScalarUI } from "openapi-metadata/ui";
import { ApiProperty, ApiOperation, ApiResponse } from "openapi-metadata/decorators";

const app = express();

class Post {
  @ApiProperty()
  declare id: number;

  @ApiProperty()
  declare title: string;
}

class PostsController {
  @ApiOperation({ summary: "List all posts" })
  @ApiResponse({ type: [Post] })
  index() {}
}

const document = await generateDocument({
  controllers: [PostsController],
  document: {
    info: {
      name: "My API",
      version: "1.0.0",
    },
  },
});

app.get("/api", async (req, res) => {
  res.send(JSON.stringify(document));
});

app.get("/api/docs", (req, res) => {
  const ui = generateScalarUI("/api");
  res.send(ui);
});

I will keep this PR as draft until v1 of Adonis OpenAPI implementation is ready to be release.

[changeset-bot]

🦋 Changeset detected

Latest commit: b9f3cae

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
openapi-metadata	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[drwpow]

This looks good to me; merge whenever!