commit fc2534edc181153efb10d3831de656a6e884d7c5 · dunkirk.sh/cachet

+57
README.md
···

       206
       206
        
       

     

       207
       207
        
       Note: Migrations must be defined in both `index.ts` and `cache.ts` to avoid circular dependencies in the import structure.

     

       208
       208
        
       

     

       209
       209
       +
       ### Adding New Routes

     

       210
       210
       +
       

     

       211
       211
       +
       The app uses a type-safe route system that automatically generates Swagger documentation from route definitions. This ensures the API docs always stay in sync with the actual implementation.

     

       212
       212
       +
       

     

       213
       213
       +
       To add a new route, you need to:

     

       214
       214
       +
       

     

       215
       215
       +
       1. Create the handler function in `src/handlers/index.ts`:

     

       216
       216
       +
       

     

       217
       217
       +
       ```typescript

     

       218
       218
       +
       export const handleMyNewEndpoint: RouteHandlerWithAnalytics = async (

     

       219
       219
       +
         request,

     

       220
       220
       +
         recordAnalytics,

     

       221
       221
       +
       ) => {

     

       222
       222
       +
         // Your handler logic here

     

       223
       223
       +
         const data = { message: "Hello from new endpoint" };

     

       224
       224
       +
       

     

       225
       225
       +
         await recordAnalytics(200);

     

       226
       226
       +
         return Response.json(data);

     

       227
       227
       +
       };

     

       228
       228
       +
       ```

     

       229
       229
       +
       

     

       230
       230
       +
       2. Add the route definition in `src/routes/api-routes.ts`:

     

       231
       231
       +
       

     

       232
       232
       +
       ```typescript

     

       233
       233
       +
       "/my-new-endpoint": {

     

       234
       234
       +
         GET: createRoute(

     

       235
       235
       +
           withAnalytics("/my-new-endpoint", "GET", handlers.handleMyNewEndpoint),

     

       236
       236
       +
           {

     

       237
       237
       +
             summary: "My new endpoint",

     

       238
       238
       +
             description: "Does something useful",

     

       239
       239
       +
             tags: ["MyFeature"],

     

       240
       240
       +
             parameters: {

     

       241
       241
       +
               query: [

     

       242
       242
       +
                 queryParam("limit", "number", "Number of items to return", false, 10)

     

       243
       243
       +
               ]

     

       244
       244
       +
             },

     

       245
       245
       +
             responses: Object.fromEntries([

     

       246
       246
       +
               apiResponse(200, "Success", {

     

       247
       247
       +
                 type: "object",

     

       248
       248
       +
                 properties: {

     

       249
       249
       +
                   message: { type: "string", example: "Hello from new endpoint" }

     

       250
       250
       +
                 }

     

       251
       251
       +
               })

     

       252
       252
       +
             ])

     

       253
       253
       +
           }

     

       254
       254
       +
         )

     

       255
       255
       +
       }

     

       256
       256
       +
       ```

     

       257
       257
       +
       

     

       258
       258
       +
       The route will automatically:

     

       259
       259
       +
       - Handle analytics recording (request timing, status codes, user agents)

     

       260
       260
       +
       - Generate Swagger documentation with the provided metadata

     

       261
       261
       +
       - Include proper TypeScript types for parameters and responses

     

       262
       262
       +
       - Validate the route definition at compile time

     

       263
       263
       +
       

     

       264
       264
       +
       No need to manually update Swagger docs or add boilerplate analytics code. The system handles all of that automatically based on your route definitions.

     

       265
       265
       +
       

     

       209
       266
        
       <p align="center">

     

       210
       267
        
       	<img src="https://raw.githubusercontent.com/taciturnaxolotl/carriage/master/.github/images/line-break.svg" />

     

       211
       268
        
       </p>