OpenAPI 명세
OpenAPI 문서는 API 명세(OpenAPI 또는 Swagger, YAML 또는 JSON)를 ERD·다이어그램·Markdown 문서와 같은 프로젝트에 보관합니다. 명세는 직접 가져오고, AI-ERD 는 그것을 쓴 그대로 저장해 화면에 그리고 내려받을 수 있는 문서로 만들어 줍니다. AI 생성 단계가 없어 크레딧을 쓰지 않습니다.
OpenAPI 문서 만들기
- File > New Document 를 열거나 프로젝트/폴더의 새 문서 동작을 누릅니다.
- 대상 프로젝트와, 필요하면 폴더를 고릅니다.
- 문서 타입으로 OpenAPI 를 선택합니다.
- 제목을 입력하고 만듭니다.
새 문서는 비어 있습니다. 원문 으로 전환해 명세를 붙여 넣으세요.
미리보기와 원문
머리글에 명세의 OpenAPI 버전, 형식, path·operation 개수가 표시됩니다. 모드는 두 가지입니다.
| 모드 | 하는 일 |
|---|---|
| 미리보기 | 명세를 API 문서 화면으로 그립니다. 읽기 전용이며 "Try it out" 이 없어서, 명세를 열어도 명세에 적힌 서버로 요청이 나가지 않습니다. |
| 원문 | 명세 원문 텍스트와 검사·저장 버튼. |
원문 에서:
- 검사 는 저장하지 않고 명세를 검증합니다.
- 저장 은 같은 검사를 통과한 것만 저장합니다. 통과하지 못하면 문제를 모두 보여 주고 아무것도 저장하지 않습니다.
- 원문은 쓴 그대로 저장됩니다 — 서식을 바꾸지 않습니다.
- 명세는 최대 1 MiB 입니다.
- 편집을 시작한 뒤 다른 사람이 먼저 저장했다면 저장이 멈추고, 다시 불러와 변경을 다시 적용하라고 안내합니다.
읽기 전용으로 공유받은 문서는 미리보기만 되고 편집할 수 없습니다.
엔드포인트 패널
오른쪽 레일의 엔드포인트 를 열면 모든 operation(메서드, 경로, 요약) 목록이 나옵니다. 하나를 누르면 미리보기가 그 위치로 스크롤됩니다. 오른쪽 레일에는 공유 도 있습니다.
내려받기
| 버튼 | 받는 것 |
|---|---|
| 원문 내려받기 | 저장된 명세 파일 그대로 (.yaml 또는 .json) |
| 문서 MD 내려받기 | 서버가 명세로 만든 Markdown API 문서 |
| PDF 내려받기 | 같은 문서를 서버가 만든 PDF |
MD·PDF 는 어느 모드에서든 받을 수 있습니다.
공개 공유
공개 링크가 있으면 누구나 로그인 없이 명세 화면을 보고 원문 파일을 내려받을 수 있습니다. 서버가 만드는 문서 MD 와 PDF 는 로그인이 필요합니다 — 로그인하지 않은 방문자에게는 로그인하거나 무료 계정을 만들라는 안내가 뜹니다.
MCP 에서 OpenAPI 문서 다루기
create_documents 에 type openapi 를 주고 명세 원문을 typePayload.content 에 넣어 만듭니다. list_documents·get_document 는 다른 문서 타입과 똑같이 동작합니다. MCP Tool Reference 를 참고하세요.