openapi-comment-parser

(★ 256)

⚓️ JSDoc Comments for the OpenAPI Specification

파일 탐색기

최종 버전 다운로드 (.zip)

- settings.json
- openapi-comment-parser.png
- index.js
- authentication.md
- describing-parameters.md
- describing-request-body.md
- describing-responses.md
- index.js
- package.json
- yarn.lock
- - app.js
  - logo.svg
  - petstore.yml
- package.json
- yarn.lock
- - index.html
  - robots.txt
  - spec.json
- - App.js
  - App.module.css
  - build-postman-request.js
  - default-dark.css
  - index.js
  - serviceWorker.js
  - theme.js
  - x-dereference.js
  - x-utils.js
- .env
- .gitignore
- index.js
- jsconfig.json
- package.json
- README.md
- yarn.lock
- - commentsToOpenApi.test.ts
  - commentsToOpenApi.ts
  - formatter.ts
  - globList.ts
  - loadDefinition.ts
  - objectMerge.test.ts
  - objectMerge.ts
  - parseFile.ts
  - yamlLOC.test.ts
  - yamlLOC.ts
- exported.d.ts
- index.test.ts
- index.ts
- options.ts
- SpecBuilder.ts
.editorconfig
.eslintignore
.eslintrc.js
.gitignore
.prettierignore
.prettierrc
.travis.yml
LICENSE
package.json
README.md
rollup.config.js
tsconfig.json
yarn.lock

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/bee-travels/openapi-comment-parser

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd openapi-comment-parser

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. 공식 설치 스크립트

쉬움 추천

사전 준비물

Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다.

npm install -g openapi-comment-parser

npm 레지스트리에 배포된 패키지를 전역으로 설치합니다. 소스 클론이 필요 없습니다.

✅ 설치 후 새 터미널을 열고, 프로그램의 버전 확인 명령(예: --version)으로 정상 설치됐는지 확인하세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

3. Node.js

쉬움

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

$ npm install openapi-comment-parser --save

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

$ yarn add openapi-comment-parser

이 명령어를 터미널에 그대로 입력해 실행하세요.

npm install -g openapi-comment-parser

npm 레지스트리에 배포된 패키지를 전역으로 설치합니다. 소스 클론이 필요 없습니다.

$ npm install eslint-plugin-openapi --save-dev

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

$ yarn add -D eslint-plugin-openapi

이 명령어를 터미널에 그대로 입력해 실행하세요.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.