Skip to content
This repository has been archived by the owner on Aug 11, 2024. It is now read-only.

feat: add tool to generate OpenAPI spec #336

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

feat: add tool to generate OpenAPI spec #336

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 68 additions & 1 deletion package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
"chance": "^1.1.11",
"class-transformer": "^0.5.1",
"class-validator": "^0.14.0",
"class-validator-jsonschema": "^4.0.0",
"clean-deep": "^3.4.0",
"connect-busboy": "^1.0.0",
"connect-pg-simple": "^9.0.1",
Expand Down Expand Up @@ -81,6 +82,7 @@
"query-string": "^7.1.3",
"reflect-metadata": "^0.1.13",
"routing-controllers": "^0.10.4",
"routing-controllers-openapi": "^4.0.0",
"slugify": "^1.6.6",
"stripe": "^9.16.0",
"tar-stream": "^3.1.6",
Expand Down
36 changes: 2 additions & 34 deletions src/api/app.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,22 +12,7 @@ import {
useExpressServer
} from "routing-controllers";

import { ApiKeyController } from "./controllers/ApiKeyController";
import { AuthController } from "./controllers/AuthController";
import { CalloutController } from "./controllers/CalloutController";
import { CalloutResponseController } from "./controllers/CalloutResponseController";
import { CalloutResponseCommentController } from "./controllers/CalloutResponseCommentController";
import { ContentController } from "./controllers/ContentController";
import { EmailController } from "./controllers/EmailController";
import { ContactController } from "./controllers/ContactController";
import { NoticeController } from "./controllers/NoticeController";
import { PaymentController } from "./controllers/PaymentController";
import { SegmentController } from "./controllers/SegmentController";
import { SignupController } from "./controllers/SignupController";
import { StatsController } from "./controllers/StatsController";
import { ResetPasswordController } from "./controllers/ResetPasswordController";
import { ResetDeviceController } from "./controllers/ResetDeviceController";
import { UploadController } from "./controllers/UploadController";
import controllers from "@api/controllers";

import { ValidateResponseInterceptor } from "./interceptors/ValidateResponseInterceptor";

Expand Down Expand Up @@ -72,24 +57,7 @@ initApp()

useExpressServer(app, {
routePrefix: "/1.0",
controllers: [
ApiKeyController,
AuthController,
CalloutController,
CalloutResponseController,
CalloutResponseCommentController,
ContentController,
EmailController,
ContactController,
NoticeController,
PaymentController,
SegmentController,
SignupController,
StatsController,
ResetPasswordController,
ResetDeviceController,
UploadController
],
controllers,
wpf500 marked this conversation as resolved.
Show resolved Hide resolved
interceptors: [ValidateResponseInterceptor],
middlewares: [AuthMiddleware],
currentUserChecker,
Expand Down
9 changes: 7 additions & 2 deletions src/api/controllers/ApiKeyController.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import {
Delete,
Param
} from "routing-controllers";
import { OpenAPI, ResponseSchema } from "routing-controllers-openapi";

import { getRepository } from "@core/database";
import { generateApiKey } from "@core/utils/auth";
Expand All @@ -24,26 +25,29 @@ import { CurrentAuth } from "@api/decorators/CurrentAuth";
import {
CreateApiKeyDto,
GetApiKeyDto,
GetApiKeysListDto,
ListApiKeysDto,
NewApiKeyDto
} from "@api/dto/ApiKeyDto";
import { PaginatedDto } from "@api/dto/PaginatedDto";
import ApiKeyTransformer from "@api/transformers/ApiKeyTransformer";

import { AuthInfo } from "@type/auth-info";

@OpenAPI({ tags: ["API Keys"] })
@JsonController("/api-key")
@Authorized("admin")
export class ApiKeyController {
@Get("/")
@ResponseSchema(GetApiKeysListDto)
async getApiKeys(
@CurrentAuth({ required: true }) auth: AuthInfo,
@QueryParams() query: ListApiKeysDto
): Promise<PaginatedDto<GetApiKeyDto>> {
): Promise<GetApiKeysListDto> {
return await ApiKeyTransformer.fetch(auth, query);
}

@Get("/:id")
@ResponseSchema(GetApiKeyDto, { statusCode: 200 })
async getApiKey(
@CurrentAuth({ required: true }) auth: AuthInfo,
@Param("id") id: string
Expand All @@ -52,6 +56,7 @@ export class ApiKeyController {
}

@Post("/")
@ResponseSchema(NewApiKeyDto)
async createApiKey(
@CurrentAuth({ required: true }) auth: AuthInfo,
@CurrentUser({ required: true }) creator: Contact,
Expand Down
22 changes: 17 additions & 5 deletions src/api/controllers/CalloutController.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import {
QueryParams,
Res
} from "routing-controllers";
import { ResponseSchema } from "routing-controllers-openapi";
import slugify from "slugify";
import { QueryDeepPartialEntity } from "typeorm/query-builder/QueryPartialEntity";

Expand All @@ -30,17 +31,18 @@ import { GetExportQuery } from "@api/dto/BaseDto";
import {
CreateCalloutDto,
GetCalloutDto,
GetCalloutListDto,
GetCalloutOptsDto,
ListCalloutsDto
} from "@api/dto/CalloutDto";
import {
CreateCalloutResponseDto,
GetCalloutResponseDto,
GetCalloutResponseListDto,
GetCalloutResponseMapDto,
GetCalloutResponseMapListDto,
ListCalloutResponsesDto
} from "@api/dto/CalloutResponseDto";
import { CreateCalloutTagDto, GetCalloutTagDto } from "@api/dto/CalloutTagDto";
import { PaginatedDto } from "@api/dto/PaginatedDto";

import { CurrentAuth } from "@api/decorators/CurrentAuth";
import PartialBody from "@api/decorators/PartialBody";
Expand All @@ -63,15 +65,17 @@ import { AuthInfo } from "@type/auth-info";
@JsonController("/callout")
export class CalloutController {
@Get("/")
@ResponseSchema(GetCalloutListDto)
async getCallouts(
@CurrentAuth() auth: AuthInfo | undefined,
@QueryParams() query: ListCalloutsDto
): Promise<PaginatedDto<GetCalloutDto>> {
): Promise<GetCalloutListDto> {
return CalloutTransformer.fetch(auth, query);
}

@Authorized("admin")
@Post("/")
@ResponseSchema(GetCalloutDto)
async createCallout(@Body() data: CreateCalloutDto): Promise<GetCalloutDto> {
const callout = await CalloutsService.createCallout(
{
Expand All @@ -84,6 +88,7 @@ export class CalloutController {
}

@Get("/:slug")
@ResponseSchema(GetCalloutDto, { statusCode: 200 })
async getCallout(
@CurrentAuth() auth: AuthInfo | undefined,
@Param("slug") slug: string,
Expand All @@ -97,6 +102,7 @@ export class CalloutController {

@Authorized("admin")
@Patch("/:slug")
@ResponseSchema(GetCalloutDto, { statusCode: 200 })
async updateCallout(
@CurrentAuth({ required: true }) auth: AuthInfo,
@Param("slug") slug: string,
Expand Down Expand Up @@ -143,11 +149,12 @@ export class CalloutController {
}

@Get("/:slug/responses")
@ResponseSchema(GetCalloutResponseListDto)
async getCalloutResponses(
@CurrentAuth({ required: true }) auth: AuthInfo,
@Param("slug") slug: string,
@QueryParams() query: ListCalloutResponsesDto
): Promise<PaginatedDto<GetCalloutResponseDto>> {
): Promise<GetCalloutResponseListDto> {
return await CalloutResponseTransformer.fetchForCallout(auth, slug, query);
}

Expand All @@ -168,11 +175,12 @@ export class CalloutController {
}

@Get("/:slug/responses/map")
@ResponseSchema(GetCalloutResponseMapListDto)
async getCalloutResponsesMap(
@CurrentAuth() auth: AuthInfo | undefined,
@Param("slug") slug: string,
@QueryParams() query: ListCalloutResponsesDto
): Promise<PaginatedDto<GetCalloutResponseMapDto>> {
): Promise<GetCalloutResponseMapListDto> {
return await CalloutResponseMapTransformer.fetchForCallout(
auth,
slug,
Expand Down Expand Up @@ -211,6 +219,7 @@ export class CalloutController {

@Authorized("admin")
@Get("/:slug/tags")
@ResponseSchema(GetCalloutTagDto, { isArray: true })
async getCalloutTags(
@CurrentAuth({ required: true }) auth: AuthInfo,
@Param("slug") slug: string
Expand All @@ -227,6 +236,7 @@ export class CalloutController {

@Authorized("admin")
@Post("/:slug/tags")
@ResponseSchema(GetCalloutTagDto)
async createCalloutTag(
@Param("slug") slug: string,
@Body() data: CreateCalloutTagDto
Expand All @@ -243,6 +253,7 @@ export class CalloutController {

@Authorized("admin")
@Get("/:slug/tags/:tag")
@ResponseSchema(GetCalloutTagDto, { statusCode: 200 })
async getCalloutTag(
@CurrentAuth({ required: true }) auth: AuthInfo,
@Param("tag") tagId: string
Expand All @@ -252,6 +263,7 @@ export class CalloutController {

@Authorized("admin")
@Patch("/:slug/tags/:tag")
@ResponseSchema(GetCalloutTagDto, { statusCode: 200 })
async updateCalloutTag(
@CurrentAuth({ required: true }) auth: AuthInfo,
@Param("slug") slug: string,
Expand Down
Loading