docs: enhance documentation: add various example

.gitignore

@@ -73,3 +73,4 @@ examples/handlers/route.ts
 examples/handlers/route-map.ts
 .eslintcache
 TODO.md
+git-short.sh

README.md

@@ -35,6 +35,7 @@ Why `fast-maker`?
   - [Route options](#route-options)
   - [Route handler](#route-handler)
 - [Example using fastify.js](#example-using-fastifyjs)
+  - [Examples](#examples)
 - [Relate To](#relate-to)
 - [Roadmaps](#roadmaps)
 - [License](#license)
@@ -235,11 +236,19 @@ export async function handler(
 }
 ```
 
-You have to `named export` and variable name must be a `handler`. Also you can use arrow function and you can use any name under TypeScript function name rule, as well as type arguments perfectly applied on route configuration
+You have to `named export` and variable name must be a `handler`. Also you can use arrow function, as well as type arguments perfectly applied on route configuration.
 
 ## Example using fastify.js
 
-A complete example of using `fast-maker` can be found at [Ma-eum](https://github.com/maeumjs/maeum-pet-store).
+A complete example of using `fast-maker` can be found at [Ma-eum](https://github.com/maeumjs/maeum-pet-store) and [examples](https://github.com/imjuni/fast-maker/tree/master/examples)
+
+### Examples
+
+- [vanilla](examples/handlers/justice/%5Bdc-league%5D/hello/get.ts)
+- [variable map](examples/handlers/avengers/heroes/%5Bid%5D/%5B%24time%5D/post.ts)
+- [multiple methods](examples/handlers/avengers/heroes/get.ts)
+- [multiple variable](examples/handlers/justice/[kind]-[id]/get.ts)
+- [function option](examples/handlers/po-ke/world/get.ts)
 
 ## Relate To
 

examples/handlers/avengers/heroes/[[id]]/get.ts

@@ -1,3 +1,10 @@
+/**
+ * Example of the nullable variable
+ *
+ * A nullable variable uses double square brackets.
+ *
+ * [[id]] replace to `:id?`
+ */
 import type { HTTPMethods } from 'fastify';
 
 export const methods: HTTPMethods = 'SEARCH';

examples/handlers/avengers/heroes/[id]/[$time]/post.ts

@@ -1,6 +1,13 @@
+/**
+ * Example of the route path map.
+ *
+ * Regular expressions, wildcards, etc. cannot be directory created, so use variable maps.
+ */
 import type { FastifyRequest } from 'fastify';
 import type { IAbility } from '../../../../../interface/IAbility';
 
+// Route path map
+// [$time] replace to `:hour(^\\d{2})h:minute(^\\d{2})m`
 export const map: Map<string, string> = new Map<string, string>([['time', ':hour(^\\d{2})h:minute(^\\d{2})m']]);
 
 export async function handler(req: FastifyRequest<{ Body: IAbility }>) {

examples/handlers/avengers/heroes/get.ts

@@ -1,6 +1,13 @@
+/**
+ * Example of the extra methods
+ *
+ * To apply more than one method to a single handler, use the `methods` variable.
+ */
 import type { HTTPMethods } from 'fastify';
 
-export const methods: HTTPMethods = 'SEARCH';
+// methods variable
+// methods variable replace to `fastify.route({ methods: ['get', 'search', 'options'] })`
+export const methods: HTTPMethods[] = ['SEARCH', 'OPTIONS'];
 
 export async function handler() {
   return 'hello';

examples/handlers/justice/[dc-league]/hello/get.ts

@@ -1,4 +1,4 @@
-import type { FastifyInstance, FastifyReply, FastifyRequest, RouteShorthandOptions } from 'fastify';
+import type { FastifyReply, FastifyRequest, RouteShorthandOptions } from 'fastify';
 import type { Server } from 'http';
 import type { IReqPokeHello } from '../../../interfaces/IReqPokeHello';
 import schema from '../../../interfaces/JSC_IReqPokeHello';
@@ -7,12 +7,12 @@ export const map: string = 'test';
 
 export const methods: number = 1;
 
-export const option: (fastify: FastifyInstance) => RouteShorthandOptions = () => ({
+export const option: RouteShorthandOptions = {
   schema: {
     querystring: schema.properties?.Querystring,
     body: schema.properties?.Body,
   },
-});
+};
 
 export async function handler(req: FastifyRequest<IReqPokeHello, Server>, _reply: FastifyReply) {
   console.debug(req.query);

examples/handlers/justice/[kind]-[id]/get.ts

@@ -1,3 +1,8 @@
+/**
+ * Example of the multiple variable in single route path element
+ *
+ * justice/[kind]-[id] replace to `justice/:kind-:id`
+ */
 import type { FastifyInstance, FastifyReply, FastifyRequest, RouteShorthandOptions } from 'fastify';
 import type { Server } from 'http';
 import type { IReqPokeHelloMultiParam } from '../../interfaces/IReqPokeHelloMultiParam';

examples/handlers/po-ke/world/get.ts

@@ -1,3 +1,11 @@
+/**
+ * Example of the function option
+ *
+ * If you need access to the fastify instance to use various hooks, including the preHandler,
+ * you can use the function option to get the fastify instance passed to you.
+ *
+ * @see https://github.com/fastify/fastify-bearer-auth?tab=readme-ov-file#integration-with-fastifyauth
+ */
 import type { FastifyInstance, FastifyReply, FastifyRequest, RouteShorthandOptions } from 'fastify';
 import type { Server } from 'http';
 import type { IReqPokeHello } from '../../interfaces/IReqPokeHello';
@@ -8,6 +16,8 @@ export const option: (fastify: FastifyInstance) => RouteShorthandOptions = () =>
     querystring: schema.properties?.Querystring,
     body: schema.properties?.Body,
   },
+  // preHandler hook using fastify instance
+  preHandler: fastify.auth([fastify.allowAnonymous, fastify.verifyBearerAuth]),
 });
 
 export const handler = async (