Skip to content

feat: swagger 문서화#11

Merged
AndyH0ng merged 8 commits intomainfrom
feat/swagger
Apr 2, 2026
Merged

feat: swagger 문서화#11
AndyH0ng merged 8 commits intomainfrom
feat/swagger

Conversation

@AndyH0ng
Copy link
Copy Markdown
Member

@AndyH0ng AndyH0ng commented Apr 2, 2026

변경 사항

@hono/swagger 문서화

관련 이슈

closes #10

체크리스트

  • 빌드 및 타입 체크가 통과합니다 (bun run type-check)
  • 새로운 기능에 대한 테스트를 추가했습니다 (해당하는 경우)
  • 하드코딩된 값 없이 src/config.ts 및 환경 변수를 사용했습니다
  • 코드에 민감한 정보(토큰, 키 등)가 포함되어 있지 않습니다

Copilot AI review requested due to automatic review settings April 2, 2026 05:38
@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages bot commented Apr 2, 2026

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
boj-jury bfa9202 Commit Preview URL Apr 02 2026, 06:06 AM

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request integrates Swagger UI and an OpenAPI 3.0.3 specification to provide API documentation. It adds documentation routes and a detailed schema covering registration, leaderboards, and admin functions. Feedback highlights an opportunity to reduce the Cloudflare Workers bundle size by removing the swagger-ui-dist package, as assets can be loaded via CDN. Other suggestions include using relative URLs in the server configuration for better local development, applying explicit date formats to schema properties, and ensuring consistent error response definitions across the API.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Cloudflare Workers(Hono) 기반 API 서버에 Swagger UI 문서 엔드포인트(/docs, /docs/spec)를 추가해, 홈페이지 v3 등 외부 연동 시 참고할 OpenAPI 문서를 제공하려는 PR입니다.

Changes:

  • @hono/swagger-ui를 이용해 Swagger UI 페이지(/docs)와 스펙 JSON(/docs/spec)을 제공
  • OpenAPI 스펙을 src/openapi.ts에 수동 정의
  • 타입체크 설정 변경 및 Swagger 관련 의존성 추가

Reviewed changes

Copilot reviewed 3 out of 5 changed files in this pull request and generated 5 comments.

File Description
tsconfig.json skipLibCheck 활성화로 라이브러리 타입 체크를 건너뜀
src/openapi.ts OpenAPI 3.0.3 스펙을 수동으로 정의
src/index.ts /docs, /docs/spec 라우트 추가로 Swagger UI/스펙 제공
package.json Swagger UI 제공을 위한 의존성 추가

@AndyH0ng AndyH0ng merged commit 6a44330 into main Apr 2, 2026
3 checks passed
@AndyH0ng AndyH0ng deleted the feat/swagger branch April 2, 2026 06:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat: swagger 문서화

2 participants