-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #33 from ts-spec/hyeonseong/feat/support-media-type
feat: support media types for reqBody.content & responses
- Loading branch information
Showing
12 changed files
with
1,282 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| # File Upload and Download | ||
|
|
||
| On this page, we will learn how to generate OpenAPI Spec for file upload and download. | ||
|
|
||
| ## File Upload | ||
|
|
||
| You can describe the file upload schema with JSDoc tag `@mediaType multipart/form-data`. | ||
| :::tip | ||
| Also, you can use other media types such as `image/png` or `application/pdf`. | ||
| See OpenAPI File Upload Documentation [here](https://swagger.io/docs/specification/describing-request-body/file-upload/). | ||
| ::: | ||
|
|
||
|
|
||
| ```ts{6-9} | ||
| export type FileApiSpec = Tspec.DefineApiSpec<{ | ||
| paths: { | ||
| '/files/upload': { | ||
| post: { | ||
| summary: 'Upload File', | ||
| /** @mediaType multipart/form-data */ | ||
| body: { | ||
| file: Tspec.BinaryString; | ||
| }, | ||
| responses: { 200: { fileName: string } }, | ||
| }, | ||
| }, | ||
| }, | ||
| }>; | ||
| ``` | ||
|
|
||
| :::details Generated OpenAPI Spec | ||
| ```yaml{6-15} | ||
| paths: | ||
| "/files/upload": | ||
| post: | ||
| operationId: FileApiSpec_post_/files/upload | ||
| summary: Upload File | ||
| requestBody: | ||
| required: true | ||
| content: | ||
| multipart/form-data: | ||
| schema: | ||
| type: object | ||
| properties: | ||
| file: | ||
| type: string | ||
| format: binary | ||
| responses: | ||
| '200': | ||
| content: | ||
| application/json: | ||
| schema: | ||
| type: object | ||
| properties: | ||
| fileName: | ||
| type: string | ||
| ``` | ||
| ::: | ||
|
|
||
| Then, you can see the file upload form in Swagger UI. | ||
|  | ||
|
|
||
|
|
||
| ## File Download | ||
|
|
||
| You can describe the file download schema with JSDoc tag `@mediaType application/octet-stream`. | ||
| :::tip | ||
| Also, you can use other media types such as `image/png` or `application/pdf`. | ||
| See OpenAPI Describing Responses Documentation [here](https://swagger.io/docs/specification/describing-responses/#file). | ||
| ::: | ||
|
|
||
| ```ts{6-9} | ||
| export type FileApiSpec = Tspec.DefineApiSpec<{ | ||
| paths: { | ||
| '/files/download': { | ||
| get: { | ||
| summary: 'Download File', | ||
| responses: { | ||
| /** @mediaType application/octet-stream */ | ||
| 200: Tspec.BinaryString | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }>; | ||
| ``` | ||
|
|
||
| :::details Generated OpenAPI Spec | ||
| ```yaml{8-12} | ||
| paths: | ||
| "/files/download": | ||
| get: | ||
| operationId: FileApiSpec_get_/files/download | ||
| summary: Download File | ||
| responses: | ||
| '200': | ||
| content: | ||
| application/octet-stream: | ||
| schema: | ||
| type: string | ||
| format: binary | ||
| ``` | ||
| ::: | ||
|
|
||
| Then, you can download the file in Swagger UI. | ||
|  |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| { | ||
| "info": { | ||
| "title": "Tspec API", | ||
| "version": "0.0.1" | ||
| }, | ||
| "openapi": "3.0.3", | ||
| "paths": { | ||
| "/files/upload": { | ||
| "post": { | ||
| "operationId": "FileApiSpec_post_/upload", | ||
| "tags": [ | ||
| "File" | ||
| ], | ||
| "summary": "Upload File", | ||
| "parameters": [], | ||
| "requestBody": { | ||
| "required": true, | ||
| "content": { | ||
| "multipart/form-data": { | ||
| "schema": { | ||
| "mediaType": "multipart/form-data", | ||
| "type": "object", | ||
| "properties": { | ||
| "file": { | ||
| "format": "binary", | ||
| "type": "string", | ||
| "example": "[\"\\x00\\x00\\x00\\x02\"]" | ||
| } | ||
| }, | ||
| "additionalProperties": false, | ||
| "required": [ | ||
| "file" | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "responses": { | ||
| "200": { | ||
| "description": "", | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "type": "object", | ||
| "properties": { | ||
| "fileName": { | ||
| "type": "string" | ||
| } | ||
| }, | ||
| "additionalProperties": false, | ||
| "required": [ | ||
| "fileName" | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "/files/download/{fileName}": { | ||
| "get": { | ||
| "operationId": "FileApiSpec_get_/download/{fileName}", | ||
| "tags": [ | ||
| "File" | ||
| ], | ||
| "summary": "Download File", | ||
| "parameters": [ | ||
| { | ||
| "name": "fileName", | ||
| "in": "path", | ||
| "required": true, | ||
| "schema": { | ||
| "type": "string" | ||
| } | ||
| } | ||
| ], | ||
| "responses": { | ||
| "200": { | ||
| "description": "", | ||
| "content": { | ||
| "application/octet-stream": { | ||
| "schema": { | ||
| "type": "object", | ||
| "properties": { | ||
| "binary": { | ||
| "format": "binary", | ||
| "type": "string", | ||
| "example": "[\"\\x00\\x00\\x00\\x02\"]" | ||
| } | ||
| }, | ||
| "additionalProperties": false, | ||
| "required": [ | ||
| "binary" | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "components": { | ||
| "schemas": {} | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| { | ||
| "name": "file-upload-download-example", | ||
| "version": "1.0.0", | ||
| "main": "index.js", | ||
| "author": "Hyeonss", | ||
| "license": "MIT", | ||
| "dependencies": { | ||
| "tspec": "^0.1.104" | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| import { Tspec, initTspecServer } from "tspec"; | ||
|
|
||
| export type FileApiSpec = Tspec.DefineApiSpec<{ | ||
| tags: ['File'], | ||
| basePath: '/files', | ||
| paths: { | ||
| '/upload': { | ||
| post: { | ||
| summary: 'Upload File', | ||
| /** @mediaType multipart/form-data */ | ||
| body: { | ||
| file: Tspec.BinaryString; | ||
| }, | ||
| responses: { 200: { fileName: string } }, | ||
| }, | ||
| }, | ||
| '/download/{fileName}': { | ||
| get: { | ||
| summary: 'Download File', | ||
| path: { fileName: string }, | ||
| responses: { | ||
| /** @mediaType application/octet-stream */ | ||
| 200: Tspec.BinaryString; | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }>; | ||
|
|
||
| initTspecServer({ outputPath: 'openapi.json', port: 3000 }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| { | ||
| "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 TC39 stage 2 draft 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": "node", /* 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. */ | ||
| // "resolveJsonModule": true, /* Enable importing .json files. */ | ||
| // "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. */ | ||
| // "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. */ | ||
| // "noEmit": true, /* Disable emitting files from a compilation. */ | ||
| // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */ | ||
| // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */ | ||
| // "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. */ | ||
| // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */ | ||
| // "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. */ | ||
| // "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */ | ||
|
|
||
| /* Interop Constraints */ | ||
| // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */ | ||
| // "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. */ | ||
| // "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. */ | ||
| } | ||
| } |
Oops, something went wrong.