@cinnabun/openapi 0.0.1 → 0.0.7

package/README.md

@@ -0,0 +1,85 @@
+# @cinnabun/openapi
+
+Auto-generate OpenAPI 3.1 specs and Swagger UI for Cinnabun applications.
+
+## Installation
+
+```bash
+bun add @cinnabun/openapi
+```
+
+## Quick Start
+
+```typescript
+import { CinnabunApp, CinnabunFactory } from "@cinnabun/core";
+import { OpenApiModule } from "@cinnabun/openapi";
+
+@CinnabunApp({
+  port: 3000,
+  scanPaths: [],
+  imports: [
+    OpenApiModule.forRoot({
+      title: "My API",
+      version: "1.0.0",
+      docsPath: "/api-docs",
+      jsonPath: "/api-docs/json",
+    }),
+  ],
+})
+class App {}
+
+CinnabunFactory.run(App);
+```
+
+Access Swagger UI at `http://localhost:3000/api-docs` and the JSON spec at `http://localhost:3000/api-docs/json`.
+
+## Decorators
+
+Annotate controllers and DTOs for richer documentation:
+
+```typescript
+import { RestController, GetMapping, PostMapping, Body } from "@cinnabun/core";
+import { ApiTags, ApiOperation, ApiResponse, ApiProperty } from "@cinnabun/openapi";
+
+@ApiTags("Users")
+@RestController("/api/users")
+class UserController {
+  @GetMapping("/")
+  @ApiOperation({ summary: "List all users" })
+  @ApiResponse({ status: 200, description: "User list" })
+  findAll() {
+    return [];
+  }
+
+  @PostMapping("/")
+  @ApiOperation({ summary: "Create user" })
+  @ApiResponse({ status: 201, description: "Created" })
+  create(@Body() body: CreateUserDto) {
+    return body;
+  }
+}
+
+class CreateUserDto {
+  @ApiProperty()
+  name!: string;
+
+  @ApiProperty()
+  email!: string;
+}
+```
+
+## Configuration
+
+```typescript
+interface OpenApiModuleOptions {
+  title?: string;
+  version?: string;
+  description?: string;
+  docsPath?: string;   // default: "/api-docs"
+  jsonPath?: string;  // default: "/api-docs/json"
+}
+```
+
+## License
+
+MIT

package/dist/openapi.module.d.ts

@@ -1,6 +1,7 @@
+import { type Constructor } from "@cinnabun/core";
 import type { OpenApiModuleOptions } from "./interfaces/openapi-options.js";
 export declare class OpenApiModule {
-    static forRoot(options: OpenApiModuleOptions): Function;
+    static forRoot(options: OpenApiModuleOptions): Constructor;
     static getOptions(): OpenApiModuleOptions;
     static resetCache(): void;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cinnabun/openapi",
-  "version": "0.0.1",
+  "version": "0.0.7",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/openapi.module.ts

@@ -1,4 +1,4 @@
-import { Module, RestController, GetMapping } from "@cinnabun/core";
+import { Module, RestController, GetMapping, type Constructor } from "@cinnabun/core";
 import type { OpenApiModuleOptions } from "./interfaces/openapi-options.js";
 import { scanRoutes } from "./generator/route-scanner.js";
 import { generateSpec, type OpenApiSpec } from "./generator/openapi-generator.js";
@@ -7,7 +7,7 @@ let moduleOptions: OpenApiModuleOptions | null = null;
 let cachedSpec: OpenApiSpec | null = null;
 
 export class OpenApiModule {
-  static forRoot(options: OpenApiModuleOptions): Function {
+  static forRoot(options: OpenApiModuleOptions): Constructor {
     moduleOptions = options;
     cachedSpec = null;