@backstage/backend-openapi-utils 0.0.1-next.0 → 0.0.2-next.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @backstage/backend-openapi-utils
 
+## 0.0.2-next.0
+
+### Patch Changes
+
+- 27956d78671: Adjusted README accordingly after the generated output now has a `.generated.ts` extension
+
+## 0.0.1
+
+### Patch Changes
+
+- 62fe726fdc5: New plugin! Primary focus is to support types on `Router`s in backend packages. Developers can use the `ApiRouter` from this package in their packages to support a typed experience based on their OpenAPI specs. The `ApiRouter` supports request bodies, response bodies, query parameters and path parameters, as well as full path-based context of the above. This means no more guessing on an endpoint like `req.post('/not-my-route', (req, res)=>{res.send(req.body.badparam)})`. Typescript would catch `/not-my-route`, `req.body.badparam`, `res.send(req.body.badparam)`.
+
 ## 0.0.1-next.0
 
 ### Patch Changes

package/README.md

@@ -8,18 +8,18 @@ This package is meant to provide a typed Express router for an OpenAPI spec. Bas
 
 ### Configuration
 
-1. Run `yarn --cwd <package-dir> backstage-cli package schema:openapi:generate` to translate your `src/schema/openapi.yaml` to a new Typescript file in `src/schema/openapi.ts`. In the case of projects that require linting + a license header, you will need to do this manually.
+1. Run `yarn --cwd <package-dir> backstage-cli package schema:openapi:generate` to translate your `src/schema/openapi.yaml` to a new Typescript file in `src/schema/openapi.generated.ts`. The command will try to execute both a lint and prettier step on the generated file, where applicable.
 
 2. In your plugin's `src/service/createRouter.ts`,
 
 ```ts
-import {ApiRouter} from `@backstage/backend-openapi-utils`;
-import spec from '../schema/openapi'
-...
-
-export function createRouter(){
+import { ApiRouter } from `@backstage/backend-openapi-utils`;
+import spec from '../schema/openapi.generated';
+// ...
+export function createRouter() {
     const router = Router() as ApiRouter<typeof spec>;
-    ...
+    // ...
+    return router;
 }
 ```
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/backend-openapi-utils",
   "description": "OpenAPI typescript support.",
-  "version": "0.0.1-next.0",
+  "version": "0.0.2-next.0",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -24,7 +24,7 @@
     "postpack": "backstage-cli package postpack"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.22.6-next.3"
+    "@backstage/cli": "^0.22.7-next.0"
   },
   "files": [
     "dist"