renamed /swagger to /docs

DA0-DA0 · Sep 20, 2024 · 7e1b22d · 7e1b22d
1 parent 9be5a32
commit 7e1b22d
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 7 deletions.
diff --git a/src/server/routes/swagger.ts → src/server/routes/docs.ts b/src/server/routes/swagger.ts → src/server/routes/docs.ts
@@ -4,7 +4,7 @@ import Koa from 'koa'
 import serve from 'koa-static'
 import { koaSwagger } from 'koa2-swagger-ui'
 
-export const setUpSwagger = (app: Koa) => {
+export const setUpDocs = (app: Koa) => {
   // Serve static folder, which contains the OpenAPI spec rendered by Swagger.
   app.use(
     serve(
@@ -26,7 +26,7 @@ export const setUpSwagger = (app: Koa) => {
     koaSwagger({
       title: 'DAO DAO API',
       hideTopbar: true,
-      routePrefix: '/swagger',
+      routePrefix: '/docs',
       favicon: 'https://daodao.zone/daodao.png',
       swaggerOptions: {
         url: './openapi.json',

diff --git a/src/server/routes/index.ts b/src/server/routes/index.ts
@@ -4,9 +4,9 @@ import Koa from 'koa'
 import { Config } from '@/types'
 
 import { accountRouter } from './account'
+import { setUpDocs } from './docs'
 import { indexerRouter } from './indexer'
 import { setUpBullBoard } from './jobs'
-import { setUpSwagger } from './swagger'
 
 export type SetupRouterOptions = {
   config: Config
@@ -34,7 +34,7 @@ export const setUpRouter = (
     setUpBullBoard(app, config)
 
     // Swagger API docs.
-    setUpSwagger(app)
+    setUpDocs(app)
 
     // Indexer API.
     router.use(indexerRouter.routes(), indexerRouter.allowedMethods())

diff --git a/src/server/test/indexer/swagger.test.ts → src/server/test/indexer/docs.test.ts b/src/server/test/indexer/swagger.test.ts → src/server/test/indexer/docs.test.ts
@@ -2,15 +2,15 @@ import request from 'supertest'
 
 import { app } from './app'
 
-describe('openapi', () => {
-  it('JSON file exists', async () => {
+describe('docs', () => {
+  it('OpenAPI JSON file exists', async () => {
     await request(app.callback())
       .get('/openapi.json')
       .expect(200)
       .expect('Content-Type', /json/)
   })
 
   it('renders', async () => {
-    await request(app.callback()).get('/swagger').expect(200)
+    await request(app.callback()).get('/docs').expect(200)
   })
 })