콘텐츠로 이동

API 레퍼런스

tinyauth는 OAuth2 및 OpenID Connect 운영을 위한 완전한 REST API를 제공해요.

요청/응답 예시와 내장 API 클라이언트를 포함하는 완전하고 대화형인 API 레퍼런스는 대화형 API 문서 에서 확인할 수 있어요.

대화형 문서는 Scalar로 구동되며 다음을 포함해요.

  • 태그별로 분류된 모든 API 엔드포인트
  • 예시가 포함된 요청/응답 스키마
  • 엔드포인트 테스트를 위한 내장 API 클라이언트
  • 인증 지원 (Bearer JWT)
태그설명
Auth사용자 인증 (로그인, 회원가입, 비밀번호 관리)
User사용자 프로필 및 계정 관리
ConsentOAuth 동의 관리
Terms이용약관 관리
OAuth Connect타사 OAuth 제공자 연결
OpenIDOpenID Connect 프로토콜 엔드포인트 (authorize, token, userinfo, JWKS)
Health서버 상태 확인

원시 OpenAPI 3.1 스펙은 JSON 파일로 제공돼요.

  • 정적 스펙: /openapi.json (빌드 시 번들)
  • 라이브 UI (openapi.enabled: true로 서버 실행 중): GET /api/docs
  • 라이브 스펙 (openapi.enabled: true로 서버 실행 중): GET /api/docs/json