Conversation
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
boj-jury | bfa9202 | Commit Preview URL | Apr 02 2026, 06:06 AM |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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 제공을 위한 의존성 추가 |
변경 사항
@hono/swagger 문서화
관련 이슈
closes #10
체크리스트
bun run type-check)src/config.ts및 환경 변수를 사용했습니다