https://github.com/kyh196201/api-doc-parser

https://github.com/kyh196201/api-doc-parser

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/kyh196201/api-doc-parser
• Owner: kyh196201
• Created: 2023-05-29T16:10:21.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-12-28T09:38:59.000Z (about 1 year ago)
• Last Synced: 2023-12-28T10:49:11.277Z (about 1 year ago)
• Language: JavaScript
• Size: 12.7 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# API 문서 파싱

## 사용 방법

### 1. api 토큰 발급 받기 

[api 토큰 링크](https://id.atlassian.com/manage-profile/security/api-tokens)

### 2. .env 파일 생성 후 필요한 정보 저장

**.env 파일 템플릿**

```

API_TOKEN='발급받은 토큰'

USER_EMAIL='로그인한 이메일'

API_DOMAIN='{api 문서 url에서 /wiki 앞에 있는 주소 전체(https 포함)}/wiki/rest/api'

```

### 3. 프로젝트 설치

```

npm i

```

### 4. 프로젝트 실행

```

node src/index.js

또는

cd src

node index.js

```

### 5. pageId, filename 입력 후 types 디렉토리에 생성되는 파일 확인

- pageId: api 문서 url에서 `pages/` 뒤에 있는 숫자

- filename: `.types.ts` 앞에 들어갈 파일 이름

### 6. 에러가 발생할 경우

- .env에 설정한 값(API_TOKEN, API_DOMAIN, USER_EMAIL)들을 index.js에 직접 입력한 다음 다시 실행해봅니다.

---

## 투두

- [ ] error code

- [ ] `content[].` 패턴

- [ ] npm run start -- pageId -- fileName