Skip to content

feat: Add API Extractor and comprehensive documentation system (v0.5.0) #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
crowrish merged 1 commit into from
Aug 19, 2025
Merged

feat: Add API Extractor and comprehensive documentation system (v0.5.0) #1

crowrish merged 1 commit into from
Aug 19, 2025

Conversation

@crowrish
Copy link
Owner

@crowrish crowrish commented Aug 19, 2025

🎯 κ°œμš”

Microsoft API Extractorλ₯Ό λ„μž…ν•˜μ—¬ 전문적인 API λ¬Έμ„œν™” μ‹œμŠ€ν…œμ„ κ΅¬μΆ•ν•˜κ³  개발 μ›Œν¬ν”Œλ‘œμš°λ₯Ό λŒ€ν­ κ°œμ„ ν–ˆμŠ΅λ‹ˆλ‹€.

✨ μƒˆλ‘œμš΄ κΈ°λŠ₯

πŸ“– API λ¬Έμ„œν™” μ‹œμŠ€ν…œ

  • Microsoft API Extractor 톡합
  • μžλ™ 생성 API λ¬Έμ„œ (docs/ 폴더, 1000+ 파일)
  • GitHub Pages 지원 - 온라인 λ¬Έμ„œ ν˜ΈμŠ€νŒ…
  • 톡합 νƒ€μž… μ„ μ–Έ 파일 (dist/neople-openapi-types.d.ts)

πŸ”§ 개발 도ꡬ κ°œμ„ 

  • API ν˜Έν™˜μ„± 좔적 (api-reports/)
  • TSDoc μ„€μ • μ΅œμ ν™” (μ»€μŠ€ν…€ @endpoint νƒœκ·Έ 지원)
  • ν–₯μƒλœ λΉŒλ“œ νŒŒμ΄ν”„λΌμΈ
  • μƒˆλ‘œμš΄ npm 슀크립트: build:full, docs:generate

πŸ“‹ 변경사항

πŸ“¦ μƒˆ νŒŒμΌλ“€

  • api-extractor.json - API Extractor μ„€μ •
  • tsdoc.json - TSDoc μ„€μ • (μ»€μŠ€ν…€ νƒœκ·Έ μ •μ˜)
  • docs/ - μžλ™ 생성 API λ¬Έμ„œ (GitHub Pages용)
  • api-reports/ - API 변경사항 좔적 파일
  • GITHUB_PAGES_SETUP.md - GitHub Pages μ„€μ • κ°€μ΄λ“œ
  • example-usage.md - API Extractor ν™œμš© μ˜ˆμ‹œ

πŸ”„ μ—…λ°μ΄νŠΈλœ νŒŒμΌλ“€

  • package.json - 버전 0.5.0, μƒˆλ‘œμš΄ 슀크립트, API Extractor μ˜μ‘΄μ„±
  • README.md - GitHub Pages 링크, 버전 νžˆμŠ€ν† λ¦¬, μƒˆλ‘œμš΄ λΉŒλ“œ λͺ…λ Ήμ–΄
  • .gitignore - API Extractor 좜λ ₯ 파일 관리

🌐 GitHub Pages λ¬Έμ„œ

μ„€μ • μ™„λ£Œ ν›„ λ‹€μŒ URLμ—μ„œ API λ¬Έμ„œμ— μ ‘κ·Όν•  수 μžˆμŠ΅λ‹ˆλ‹€:

https://crowrish.github.io/neople-openapi-types/

μ„€μ • 방법:

  1. GitHub μ €μž₯μ†Œ β†’ Settings β†’ Pages
  2. Source: "Deploy from a branch"
  3. Branch: main, Folder: /docs

πŸ”§ μƒˆλ‘œμš΄ 개발 μ›Œν¬ν”Œλ‘œμš°

λΉŒλ“œ λͺ…λ Ήμ–΄

npm run build:full    # 전체 λΉŒλ“œ + API μΆ”μΆœ
npm run docs:generate # API λ¬Έμ„œ 생성
npm run api-extract   # API Extractor만 μ‹€ν–‰

μžλ™ν™”λœ 검증

  • 배포 μ „ API ν˜Έν™˜μ„± 검증 (prepublishOnly)
  • Breaking change μžλ™ 감지
  • 톡합 νƒ€μž… 파일 생성

🎁 개발자 κ²½ν—˜ κ°œμ„ 

βœ… npm μ‚¬μš©μž (λ³€ν™” μ—†μŒ)

  • νŒ¨ν‚€μ§€ 크기 동일 (μ•½ 31.5 kB)
  • λ™μΌν•œ μ‚¬μš©λ²•
  • dist/ ν΄λ”λ§Œ 포함 (λ¬Έμ„œ 파일 μ œμ™Έ)

βœ… ν”„λ‘œμ νŠΈ κΈ°μ—¬μž (λŒ€ν­ κ°œμ„ )

  • πŸ“Š API 변경사항 μžλ™ 좔적
  • πŸ“– 전문적인 온라인 λ¬Έμ„œ
  • πŸ” 톡합 νƒ€μž… μ„ μ–Έ 파일
  • πŸ›‘οΈ API ν˜Έν™˜μ„± 보μž₯

πŸ§ͺ ν…ŒμŠ€νŠΈ μ™„λ£Œ

  • βœ… λͺ¨λ“  κΈ°μ‘΄ κΈ°λŠ₯ 정상 μž‘λ™
  • βœ… μƒˆλ‘œμš΄ λΉŒλ“œ νŒŒμ΄ν”„λΌμΈ 검증
  • βœ… API Extractor κ²½κ³  μ—†μŒ
  • βœ… λ¬Έμ„œ 생성 성곡

🎯 λ‹€μŒ 단계

  1. PR 병합 ν›„ GitHub Pages μ„€μ •
  2. 온라인 λ¬Έμ„œ 확인 (https://crowrish.github.io/neople-openapi-types/)
  3. v0.5.0 npm 배포

πŸ€– Generated with Claude Code

@crowrish @claude
feat: Add API Extractor and comprehensive documentation system
1423fa4 
✨ New Features:
- Microsoft API Extractor integration for API surface management
- Auto-generated API documentation with GitHub Pages support
- Comprehensive type documentation in docs/ folder
- API compatibility tracking with api-reports/

πŸ”§ Improvements:
- TSDoc configuration with custom @endpoint tag support
- Enhanced build pipeline with documentation generation
- New npm scripts: build:full, docs:generate
- Version bump to 0.5.0

πŸ“– Documentation:
- GitHub Pages setup guide (GITHUB_PAGES_SETUP.md)
- API usage examples (example-usage.md)
- Online documentation link in README.md
- Updated version history

πŸ› οΈ Technical Changes:
- Added tsdoc.json for TSDoc configuration
- Updated .gitignore for API Extractor outputs
- Enhanced package.json with new scripts
- Unified type declarations in dist/neople-openapi-types.d.ts

🎯 Benefits:
- Professional API documentation website
- Automated API compatibility tracking
- Improved developer experience
- Better maintenance workflow

πŸ€– Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@crowrish crowrish merged commit bb38b50 into main Aug 19, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@crowrish