next-openapi-gen 0.8.7 → 0.8.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +18 -0
- package/dist/lib/route-processor.js +1 -1
- package/dist/lib/utils.js +9 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -201,6 +201,7 @@ export async function POST(request: NextRequest) {
|
|
|
201
201
|
| Tag | Description |
|
|
202
202
|
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------ |
|
|
203
203
|
| `@description` | Endpoint description |
|
|
204
|
+
| `@operationId` | Custom operation ID (overrides auto-generated ID) |
|
|
204
205
|
| `@pathParams` | Path parameters type/schema |
|
|
205
206
|
| `@params` | Query parameters type/schema |
|
|
206
207
|
| `@body` | Request body type/schema |
|
|
@@ -424,6 +425,23 @@ export async function GET() {
|
|
|
424
425
|
}
|
|
425
426
|
```
|
|
426
427
|
|
|
428
|
+
### Custom Operation ID
|
|
429
|
+
|
|
430
|
+
```typescript
|
|
431
|
+
// src/app/api/users/[id]/route.ts
|
|
432
|
+
|
|
433
|
+
/**
|
|
434
|
+
* Get user by ID
|
|
435
|
+
* @operationId getUserById
|
|
436
|
+
* @pathParams UserParams
|
|
437
|
+
* @response UserResponse
|
|
438
|
+
*/
|
|
439
|
+
export async function GET() {
|
|
440
|
+
// ...
|
|
441
|
+
}
|
|
442
|
+
// Generates: operationId: "getUserById" instead of auto-generated "get-users-{id}"
|
|
443
|
+
```
|
|
444
|
+
|
|
427
445
|
### File Uploads / Multipart Form Data
|
|
428
446
|
|
|
429
447
|
```typescript
|
|
@@ -248,7 +248,7 @@ export class RouteProcessor {
|
|
|
248
248
|
const method = varName.toLowerCase();
|
|
249
249
|
const routePath = this.getRoutePath(filePath);
|
|
250
250
|
const rootPath = capitalize(routePath.split("/")[1]);
|
|
251
|
-
const operationId = getOperationId(routePath, method);
|
|
251
|
+
const operationId = dataTypes.operationId || getOperationId(routePath, method);
|
|
252
252
|
const { tag, summary, description, auth, isOpenApi, deprecated, bodyDescription, responseDescription, } = dataTypes;
|
|
253
253
|
if (this.config.includeOpenApiRoutes && !isOpenApi) {
|
|
254
254
|
// If flag is enabled and there is no @openapi tag, then skip path
|
package/dist/lib/utils.js
CHANGED
|
@@ -34,6 +34,7 @@ export function extractJSDocComments(path) {
|
|
|
34
34
|
let responseSet = "";
|
|
35
35
|
let addResponses = "";
|
|
36
36
|
let successCode = "";
|
|
37
|
+
let operationId = "";
|
|
37
38
|
if (comments) {
|
|
38
39
|
comments.forEach((comment) => {
|
|
39
40
|
const commentValue = cleanComment(comment.value);
|
|
@@ -124,6 +125,13 @@ export function extractJSDocComments(path) {
|
|
|
124
125
|
addResponses = match[1].trim();
|
|
125
126
|
}
|
|
126
127
|
}
|
|
128
|
+
if (commentValue.includes("@operationId")) {
|
|
129
|
+
const regex = /@operationId\s+(\S+)/;
|
|
130
|
+
const match = commentValue.match(regex);
|
|
131
|
+
if (match && match[1]) {
|
|
132
|
+
operationId = match[1].trim();
|
|
133
|
+
}
|
|
134
|
+
}
|
|
127
135
|
if (commentValue.includes("@response")) {
|
|
128
136
|
// Updated regex to support generic types
|
|
129
137
|
const responseMatch = commentValue.match(/@response\s+(?:(\d+):)?([^@\n\r]+)(?:\s+(.*))?/);
|
|
@@ -156,6 +164,7 @@ export function extractJSDocComments(path) {
|
|
|
156
164
|
responseSet,
|
|
157
165
|
addResponses,
|
|
158
166
|
successCode,
|
|
167
|
+
operationId,
|
|
159
168
|
};
|
|
160
169
|
}
|
|
161
170
|
export function extractTypeFromComment(commentValue, tag) {
|
package/package.json
CHANGED