Merge pull request #14 from Leroyalle/dev

integrate OpenAPI and Sclar for docs

Author: Leroyalle

bun.lock

@@ -11,6 +11,6 @@ module.exports = {
     'subject-empty': [2, 'never'],
     'type-case': [2, 'always', 'lower-case'],
     'type-empty': [2, 'never'],
-    'type-enum': [2, 'always', ['feat', 'fix', 'refactor', 'chore', 'docs']],
+    'type-enum': [2, 'always', ['feat', 'fix', 'refactor', 'chore', 'docs', 'test']],
   },
 };

commitlint.config.cjs

@@ -11,13 +11,16 @@
   },
   "dependencies": {
     "@faker-js/faker": "^10.3.0",
+    "@hono/zod-openapi": "^1.2.2",
     "@hono/zod-validator": "^0.7.6",
     "@saintleroyalle/core": "^1.0.2",
+    "@scalar/hono-api-reference": "^0.9.41",
     "arctic": "^3.7.0",
     "argon2": "^0.44.0",
     "bullmq": "^5.67.3",
     "dotenv": "^17.2.3",
     "drizzle-orm": "^0.45.1",
+    "drizzle-zod": "^0.8.3",
     "grammy": "^1.39.3",
     "hono": "^4.11.7",
     "ioredis": "^5.9.2",

package.json

@@ -1,4 +1,5 @@
-import { Hono } from 'hono';
+import { OpenAPIHono } from '@hono/zod-openapi';
+import { Scalar } from '@scalar/hono-api-reference';
 import { cors } from 'hono/cors';
 
 import { createMiddlewares } from './middlewares';
@@ -9,10 +10,46 @@ import { createCategoryRouter } from './modules/category/category.router';
 import { createOrderRouter } from './modules/order/order.router';
 import { createProductRouter } from './modules/product/product.router';
 import { createUserRouter } from './modules/user/user.router';
+import { SECURITY_SCHEMES } from './shared/constants/security-schemes.constants';
 import { ERROR_HTTP_STATUS } from './shared/exceptions/error-status-map';
 import { resolveErrorCode } from './shared/exceptions/resolve-error-code';
 
-const app = new Hono().basePath('/api');
+const app = new OpenAPIHono().basePath('/api');
+
+app.openAPIRegistry.registerComponent('securitySchemes', SECURITY_SCHEMES.ACCESS_TOKEN_COOKIE, {
+  type: 'apiKey',
+  in: 'cookie',
+  name: 'accessToken',
+});
+
+app.openAPIRegistry.registerComponent('securitySchemes', SECURITY_SCHEMES.REFRESH_TOKEN_COOKIE, {
+  type: 'apiKey',
+  in: 'cookie',
+  name: 'refreshToken',
+});
+
+app.doc('/openapi.json', {
+  openapi: '3.0.0',
+  info: {
+    title: 'Ecommerce Backend Starter',
+    version: '1.0.0',
+  },
+  tags: [
+    { name: 'Auth', description: 'Авторизация и аутентификация' },
+    { name: 'Products', description: 'Работа с продуктами' },
+    { name: 'Categories', description: 'Работа с категориями' },
+    { name: 'Cart', description: 'Корзина пользователя' },
+    { name: 'Orders', description: 'Заказы пользователя' },
+    { name: 'Users', description: 'Работа с пользователями' },
+  ],
+});
+
+app.get(
+  '/docs',
+  Scalar({
+    url: '/api/openapi.json',
+  }),
+);
 
 app.use(
   '*',