MIT 라이선스 하에 배포되었습니다.
Akan.js 공식 컨설팅 서비스
Akansoft
Copyright © 2026 Akan.js 모든 권리 보유.
시스템 관리자
bassman
Akan.js
한국어
English
한국어
문서
컨벤션
레퍼런스
Cheatsheet
Akan.js
문서
컨벤션
레퍼런스
Cheatsheet
일반
•
인증
•
스키마 설계
•
엣지 컴퓨팅
•
파일 관리
•
Single Sign-On
•
DataList & Enum
인터페이스
•
CRUD
•
Endpoint
•
Form
관측성
•
로깅
•
의존성 주입
•
에러 처리
•
메트릭
성능
•
캐싱
•
이미지 최적화
•
지연 로딩
•
쿼리
•
큐
•
실시간
개발
•
문서화
•
스크립트
•
도커
•
쿠버네티스
일반
•
인증
•
스키마 설계
•
엣지 컴퓨팅
•
파일 관리
•
Single Sign-On
•
DataList & Enum
인터페이스
•
CRUD
•
Endpoint
•
Form
관측성
•
로깅
•
의존성 주입
•
에러 처리
•
메트릭
성능
•
캐싱
•
이미지 최적화
•
지연 로딩
•
쿼리
•
큐
•
실시간
개발
•
문서화
•
스크립트
•
도커
•
쿠버네티스
이전
실시간
다음
스크립트
API 문서
Akan은 생성된 fetch 객체에서 signal 문서를 렌더링할 수 있습니다. 단순한 목록이 아니라 argument, guard, REST 호출, realtime endpoint를 확인할 수 있습니다.
하나의 signal namespace에는 `Signal.Doc.Zone`을 사용합니다.
`Doc.Setting`에서 BaseURL, role, JWT를 조절합니다.
REST와 WebSocket 테스트 화면을 함께 볼 수 있습니다.
Zone 렌더링
문서 UI는 admin 또는 developer 전용 page에 두세요. `base` signal은 간단한 ping endpoint가 있어서 첫 실습 대상으로 좋습니다.
개발자 API page
Endpoint 실습
`base` 문서를 열고 `ping`을 찾아 REST panel에서 실행해보세요. 단순한 문자열 응답이 돌아옵니다.
Auth와 role
Guard가 있는 endpoint는 auth modal을 열고 JWT를 붙여넣으세요. Decode된 account를 보면 어떤 role로 테스트하는지 확인할 수 있습니다.
BaseURL은 문서가 어떤 서버를 호출하는지 보여줍니다.
Role filter는 public, user, admin endpoint를 나눠 보는 데 도움됩니다.
JWT는 이 UI에서 개발자 테스트용으로만 사용하세요.
꿀팁
API 문서는 developer 또는 admin에게만 노출하세요.
큰 domain을 문서화하기 전에 `base`나 작은 module부터 시작하세요.
문서 UI는 빠른 수동 점검에 사용하고, 자동 테스트의 대체물로 보지는 마세요.
API 문서
Zone 렌더링
Endpoint 실습
Auth와 role
꿀팁
GET
/ping
(Ping)
Description
- Ping 테스트 엔드포인트
View Doc
Restful API
Response Type
Returns:
String!
Response Example
"String"
Copy
