├── .gitignore ├── LICENSE ├── app.ts ├── package.json ├── routes └── root.ts ├── server.ts └── tsconfig.json /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | lerna-debug.log* 8 | 9 | # Diagnostic reports (https://nodejs.org/api/report.html) 10 | report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json 11 | 12 | # Runtime data 13 | pids 14 | *.pid 15 | *.seed 16 | *.pid.lock 17 | 18 | # Directory for instrumented libs generated by jscoverage/JSCover 19 | lib-cov 20 | 21 | # Coverage directory used by tools like istanbul 22 | coverage 23 | *.lcov 24 | 25 | # nyc test coverage 26 | .nyc_output 27 | 28 | # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) 29 | .grunt 30 | 31 | # Bower dependency directory (https://bower.io/) 32 | bower_components 33 | 34 | # node-waf configuration 35 | .lock-wscript 36 | 37 | # Compiled binary addons (https://nodejs.org/api/addons.html) 38 | build/Release 39 | 40 | # Dependency directories 41 | node_modules/ 42 | jspm_packages/ 43 | 44 | # TypeScript v1 declaration files 45 | typings/ 46 | 47 | # TypeScript cache 48 | *.tsbuildinfo 49 | 50 | # Optional npm cache directory 51 | .npm 52 | 53 | # Optional eslint cache 54 | .eslintcache 55 | 56 | # Microbundle cache 57 | .rpt2_cache/ 58 | .rts2_cache_cjs/ 59 | .rts2_cache_es/ 60 | .rts2_cache_umd/ 61 | 62 | # Optional REPL history 63 | .node_repl_history 64 | 65 | # Output of 'npm pack' 66 | *.tgz 67 | 68 | # Yarn Integrity file 69 | .yarn-integrity 70 | 71 | # dotenv environment variables file 72 | .env 73 | .env.test 74 | 75 | # parcel-bundler cache (https://parceljs.org/) 76 | .cache 77 | 78 | # Next.js build output 79 | .next 80 | 81 | # Nuxt.js build / generate output 82 | .nuxt 83 | dist 84 | 85 | # Gatsby files 86 | .cache/ 87 | # Comment in the public line in if your project uses Gatsby and *not* Next.js 88 | # https://nextjs.org/blog/next-9-1#public-directory-support 89 | # public 90 | 91 | # vuepress build output 92 | .vuepress/dist 93 | 94 | # Serverless directories 95 | .serverless/ 96 | 97 | # FuseBox cache 98 | .fusebox/ 99 | 100 | # DynamoDB Local files 101 | .dynamodb/ 102 | 103 | # TernJS port file 104 | .tern-port 105 | build 106 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2023 Matteo Collina 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /app.ts: -------------------------------------------------------------------------------- 1 | import Fastify from 'fastify'; 2 | import AutoLoad from '@fastify/autoload'; 3 | import Swagger from '@fastify/swagger'; 4 | import SwaggerUI from '@fastify/swagger-ui'; 5 | 6 | export function build () { 7 | const server = Fastify(); 8 | 9 | server.register(Swagger); 10 | server.register(SwaggerUI); 11 | 12 | server.register(AutoLoad, { 13 | dir: `${__dirname}/routes`, 14 | }); 15 | 16 | return server 17 | } 18 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "type-safe-fastify", 3 | "private": true, 4 | "version": "0.0.1", 5 | "description": "", 6 | "main": "index.js", 7 | "scripts": { 8 | "build": "rm -rf build && tsc", 9 | "test": "echo \"Error: no test specified\" && exit 1" 10 | }, 11 | "repository": { 12 | "type": "git", 13 | "url": "git+https://github.com/mcollina/type-safe-fastify.git" 14 | }, 15 | "keywords": [], 16 | "author": "Matteo Collina ", 17 | "license": "MIT", 18 | "bugs": { 19 | "url": "https://github.com/mcollina/type-safe-fastify/issues" 20 | }, 21 | "homepage": "https://github.com/mcollina/type-safe-fastify#readme", 22 | "devDependencies": { 23 | "@types/node": "^18.14.2", 24 | "fastify-tsconfig": "^1.0.1", 25 | "typescript": "^4.9.5" 26 | }, 27 | "dependencies": { 28 | "@fastify/autoload": "^5.7.1", 29 | "@fastify/swagger": "^8.3.1", 30 | "@fastify/swagger-ui": "^1.4.0", 31 | "@fastify/type-provider-typebox": "^2.4.0", 32 | "@sinclair/typebox": "^0.25.24", 33 | "fastify": "^4.13.0" 34 | } 35 | } 36 | -------------------------------------------------------------------------------- /routes/root.ts: -------------------------------------------------------------------------------- 1 | import { Type } from '@sinclair/typebox'; 2 | import { FastifyPluginAsyncTypebox } from '@fastify/type-provider-typebox' 3 | 4 | const plugin: FastifyPluginAsyncTypebox = async function(fastify, _opts) { 5 | fastify.get('/', { 6 | schema: { 7 | querystring: Type.Object({ 8 | name: Type.String({ default: 'world' }) 9 | }), 10 | response: { 11 | 200: Type.Object({ 12 | hello: Type.String() 13 | }) 14 | } 15 | } 16 | }, (req) => { 17 | const { name } = req.query; 18 | return { hello: name }; 19 | }); 20 | 21 | fastify.post('/', { 22 | schema: { 23 | body: Type.Object({ 24 | name: Type.String() 25 | }), 26 | response: { 27 | 200: Type.Object({ 28 | hello: Type.String() 29 | }) 30 | } 31 | } 32 | }, async (request) => { 33 | const { name } = request.body; 34 | return { hello: name || 'world' }; 35 | }); 36 | } 37 | 38 | export default plugin; 39 | -------------------------------------------------------------------------------- /server.ts: -------------------------------------------------------------------------------- 1 | import { build } from './app'; 2 | 3 | const server = build(); 4 | server.listen({ port: 3000 }); 5 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "fastify-tsconfig", 3 | "compilerOptions": { 4 | "outDir": "build", 5 | "target": "es2018", 6 | "lib": ["es2018"] 7 | } 8 | } 9 | --------------------------------------------------------------------------------