feat(sensible): add http error examples with sensible

Author: FlandiaYingman

src/plugins/sensible.ts

@@ -1,11 +1,16 @@
 import fp from "fastify-plugin";
 import sensible from "@fastify/sensible";
+import { Type } from "@sinclair/typebox";
+
+export const HttpError = Type.Ref("HttpError");
 
 /**
  * This plugin adds some utilities to handle http errors.
  *
  * @see https://github.com/fastify/fastify-sensible
  */
 export default fp(async (fastify) => {
-  fastify.register(sensible);
+  fastify.register(sensible, {
+    sharedSchemaId: "HttpError",
+  });
 });

src/routes/example/index.ts

@@ -1,6 +1,7 @@
 import { FastifyPluginAsync } from "fastify";
 import { FastifyTypebox } from "../../app.js";
 import { Type } from "@sinclair/typebox";
+import { HttpError } from "../../plugins/sensible.js";
 
 const example: FastifyPluginAsync = async (
   fastify: FastifyTypebox,
@@ -21,6 +22,21 @@ const example: FastifyPluginAsync = async (
       return "this is an example";
     },
   );
+  fastify.get(
+    "/error",
+    {
+      schema: {
+        summary: "Get Example with Some Errors",
+        tags: ["Example"],
+        response: {
+          200: HttpError,
+        },
+      },
+    },
+    async function (request, reply) {
+      return reply.badRequest("this is an error example");
+    },
+  );
 };
 
 export default example;