backstage/docs/openapi/generate-client.md at a07b3b373c7dfef28d4c8a62bcf7739aa3a2a43c - backstage - Private Git

paulononato/backstage

Files

T

Aramis Sennyey 38340678c3 feat(openapi): Create Backstage plugins through generator tooling.

Signed-off-by: Aramis Sennyey <sennyeya@amazon.com>
Signed-off-by: Aramis Sennyey <sennyeyaramis@gmail.com>
Signed-off-by: Aramis Sennyey <aramiss@spotify.com>

2023-11-17 13:58:25 -05:00

1.1 KiB

Raw Blame History

How to generate a client with `repo-tools schema openapi generate-client`?

Prerequisites

Add your plugin ID as the last servers item, like this,

servers:
  # first value, used for OpenAPI router validation.
  - url: /

  # final value, pluginId.
  - url: catalog

Find or create a new plugin to house your new generated client. Currently, we do not support generating an entirely new plugin and instead just generate client files.

Generating your client

Run yarn backstage-repo-tools schema openapi generate-client --input-spec <file> --output-directory <directory>. This will create a new folder in <directory>/src/generated to house the generated content.
You should use the generated files as follows,

apis/DefaultApi.client.ts - this is the client that you should use. It has types for all of the various operations on your API.
models/* - These are the types generated from your OpenAPI file, ideally you should not need to use these directly and can instead use the inferred types from apis/DefaultApi.client.ts.
everything else is directory specific and shouldn't be touched.