Git Product home page Git Product logo

api-doc-parser's Introduction

API 문서 파싱

사용 방법

1. api 토큰 발급 받기

api 토큰 링크

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

api-doc-parser's People

Contributors

kyh196201 avatar

Stargazers

Jiwon Lim avatar Léo Fabrício avatar

Watchers

avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.