Skip to content

Commit

Permalink
docs swagger added
Browse files Browse the repository at this point in the history
  • Loading branch information
Piootrekk committed Dec 5, 2024
1 parent 1c137a8 commit e17f27d
Show file tree
Hide file tree
Showing 11 changed files with 93 additions and 138 deletions.
10 changes: 5 additions & 5 deletions express-proxy/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ app.get("/", (req, res) => {
res.redirect("/api-docs");
});

app.get("/get/:path(*)", async (req, res) => {
app.get("/link/:path(*)", async (req, res) => {
try {
const decodedPath = decodeURIComponent(req.params.path);
console.log("Received request to /get with path:", decodedPath);
Expand All @@ -41,7 +41,7 @@ app.get("/get/:path(*)", async (req, res) => {
}
});

app.post("/post/:path(*)", async (req, res) => {
app.post("/link/:path(*)", async (req, res) => {
try {
const requestData = req.body;
console.log(requestData);
Expand All @@ -65,10 +65,10 @@ app.post("/post/:path(*)", async (req, res) => {
}
});

app.put("/put/:path(*)", async (req, res) => {
app.put("/link/:path(*)", async (req, res) => {
try {
const decodedPath = decodeURIComponent(req.params.path);
console.log("Received PUT request to /putNormal with path:", decodedPath);
console.log("Received PUT request to /put with path:", decodedPath);

const response = await axios.put(decodedPath, req.body);
res.json(response.data);
Expand All @@ -82,7 +82,7 @@ app.put("/put/:path(*)", async (req, res) => {
}
});

app.delete("/delete/:path(*)", async (req, res) => {
app.delete("/link/:path(*)", async (req, res) => {
try {
const decodedPath = decodeURIComponent(req.params.path);
console.log("Received DELETE request to /delete with path:", decodedPath);
Expand Down
4 changes: 3 additions & 1 deletion fastify-proxy/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@
"main": "index.js",
"license": "MIT",
"scripts": {
"dev": "tsnd --respawn --transpile-only --exit-child src/server.ts"
"dev": "tsnd --respawn --transpile-only --exit-child src/server.ts",
"build": "tsc",
"start": "node dist/server.js"
},
"dependencies": {
"@fastify/cors": "^10.0.1",
Expand Down
9 changes: 5 additions & 4 deletions fastify-proxy/src/app.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,17 @@ import Fastify from "fastify";
import urlRoutes from "./modules/url/url.route";
import swaggerPlugin from "./plugins/swagger";
import cors from "@fastify/cors";
import healthRoutes from "./modules/health/health.route";

const buildApp = async () => {
const app = Fastify({
logger: true,
});

app.register(cors);
app.register(swaggerPlugin);
app.register(urlRoutes, { prefix: "url" });

await app.register(cors);
await app.register(swaggerPlugin);
await app.register(urlRoutes, { prefix: "/url" });
await app.register(healthRoutes, { prefix: "/health" });
return app;
};

Expand Down
7 changes: 7 additions & 0 deletions fastify-proxy/src/modules/health/health.controller.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import { FastifyReply, FastifyRequest } from "fastify";

const getHealth = async (request: FastifyRequest, reply: FastifyReply) => {
reply.send({ health: true });
};

export { getHealth };
20 changes: 20 additions & 0 deletions fastify-proxy/src/modules/health/health.route.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
import { FastifyInstance } from "fastify";
import { getHealth } from "./health.controller";
import { healthResponseSchemaJson } from "./health.schema";

const healthRoutes = async (server: FastifyInstance) => {
server.get(
"/",
{
schema: {
tags: ["Health"],
response: {
"2xx": healthResponseSchemaJson,
},
},
},
getHealth
);
};

export default healthRoutes;
10 changes: 10 additions & 0 deletions fastify-proxy/src/modules/health/health.schema.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
import { z } from "zod";
import zodToJsonSchema from "zod-to-json-schema";

const responseSchema = z.object({
health: z.boolean(),
});

const healthResponseSchemaJson = zodToJsonSchema(responseSchema);

export { healthResponseSchemaJson };
19 changes: 19 additions & 0 deletions fastify-proxy/src/modules/url/url.hook.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import { FastifyReply, FastifyRequest } from "fastify";
import { TUrlQuery } from "./url.schema";

const preHandler = async (
request: FastifyRequest<{
Querystring: TUrlQuery;
}>,
reply: FastifyReply
) => {
const rawQuery = request.raw.url?.split("?link=")[1];
if (!rawQuery) {
reply.status(400).send({ error: 'Missing "link" parameter' });
return;
}
const encodeURL = decodeURIComponent(rawQuery);
request.query = { link: encodeURL };
};

export { preHandler };
8 changes: 7 additions & 1 deletion fastify-proxy/src/modules/url/url.route.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,26 +12,29 @@ import {
urlResponseRerrorSchemaJson,
urlResponseSchemaJson,
} from "./url.schema";

import { preHandler } from "./url.hook";
const urlRoutes = async (server: FastifyInstance) => {
server.get(
"/",
{
schema: {
tags: ["URL"],
querystring: urlQuerySchemaJson,
response: {
"2xx": urlResponseSchemaJson,
"4xx": urlResponseRerrorSchemaJson,
"5xx": urlResponseRerrorSchemaJson,
},
},
preHandler,
},
getUrlHandler
);
server.post(
"/",
{
schema: {
tags: ["URL"],
querystring: urlQuerySchemaJson,
body: urlBodySchemaJson,
response: {
Expand All @@ -47,6 +50,7 @@ const urlRoutes = async (server: FastifyInstance) => {
"/",
{
schema: {
tags: ["URL"],
querystring: urlQuerySchemaJson,
response: {
"2xx": urlResponseSchemaJson,
Expand All @@ -61,6 +65,7 @@ const urlRoutes = async (server: FastifyInstance) => {
"/",
{
schema: {
tags: ["URL"],
querystring: urlQuerySchemaJson,
body: urlBodySchemaJson,
response: {
Expand All @@ -76,6 +81,7 @@ const urlRoutes = async (server: FastifyInstance) => {
"/",
{
schema: {
tags: ["URL"],
querystring: urlQuerySchemaJson,
body: urlBodySchemaJson,
response: {
Expand Down
12 changes: 1 addition & 11 deletions fastify-proxy/src/modules/url/url.schema.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,7 @@ import { z } from "zod";
import zodToJsonSchema from "zod-to-json-schema";

export const urlQuerySchema = z.object({
link: z.string().refine(
(val) => {
try {
new URL(val);
return true;
} catch {
return false;
}
},
{ message: "Invalid URL format" }
),
link: z.string().url({ message: "Has to be URL" }),
});

const urlBodySchema = z.record(z.any());
Expand Down
14 changes: 6 additions & 8 deletions fastify-proxy/src/plugins/swagger.ts
Original file line number Diff line number Diff line change
@@ -1,22 +1,20 @@
import { FastifyPluginCallback } from "fastify";
import fp from "fastify-plugin";
import FastifySwagger from "@fastify/swagger";
import FastifySwaggerUi from "@fastify/swagger-ui";

const swagger: FastifyPluginCallback = async (fastify, _, done) => {
const swaggerPlugin = fp(async (fastify) => {
await fastify.register(FastifySwagger, {
openapi: {
info: {
title: "CRUD PROXY",
version: "1.0.0",
version: "1",
},
},
});

await fastify.register(FastifySwaggerUi, {
routePrefix: "/docs",
routePrefix: "/",
});
});

done();
};

export default swagger;
export default swaggerPlugin;
118 changes: 10 additions & 108 deletions fastify-proxy/tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,111 +1,13 @@
{
"compilerOptions": {
/* Visit https://aka.ms/tsconfig to read more about this file */

/* Projects */
// "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
// "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */

/* Language and Environment */
"target": "es2016", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
// "jsx": "preserve", /* Specify what JSX code is generated. */
// "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
// "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */

/* Modules */
"module": "commonjs", /* Specify what module code is generated. */
// "rootDir": "./", /* Specify the root folder within your source files. */
// "moduleResolution": "node10", /* Specify how TypeScript looks up a file from a given module specifier. */
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
// "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
// "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
// "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
// "rewriteRelativeImportExtensions": true, /* Rewrite '.ts', '.tsx', '.mts', and '.cts' file extensions in relative import paths to their JavaScript equivalent in output files. */
// "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */
// "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */
// "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
// "noUncheckedSideEffectImports": true, /* Check side effect imports. */
// "resolveJsonModule": true, /* Enable importing .json files. */
// "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */
// "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */

/* JavaScript Support */
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */

/* Emit */
// "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
// "noEmit": true, /* Disable emitting files from a compilation. */
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
// "outDir": "./", /* Specify an output folder for all emitted files. */
// "removeComments": true, /* Disable emitting comments. */
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
// "newLine": "crlf", /* Set the newline character for emitting files. */
// "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
// "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
// "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */

/* Interop Constraints */
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
// "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
// "isolatedDeclarations": true, /* Require sufficient annotation on exports so other tools can trivially generate declaration files. */
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */

/* Type Checking */
"strict": true, /* Enable all strict type-checking options. */
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
// "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
// "strictBuiltinIteratorReturn": true, /* Built-in iterators are instantiated with a 'TReturn' type of 'undefined' instead of 'any'. */
// "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
// "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
// "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
// "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */

/* Completeness */
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
"skipLibCheck": true /* Skip type checking all .d.ts files. */
}
"target": "ES2020",
"module": "commonjs",
"outDir": "./dist",
"rootDir": "./src",
"strict": true,
"esModuleInterop": true,
"skipLibCheck": true
},
"include": ["src/**/*"],
"exclude": ["node_modules"]
}

0 comments on commit e17f27d

Please sign in to comment.