tspec
Type-driven API Documentation library. Auto-generating REST API document based on TypeScript types.
파일 탐색기
최종 버전 다운로드 (.zip)- bug_report.md
- feature_request.md
- code-review.yml
- deploy.yml
- release.yml
- test.yml
- _metadata.json
- chunk-LJKO4TMH.js
- chunk-LJKO4TMH.js.map
- chunk-QE257C5J.js
- chunk-QE257C5J.js.map
- package.json
- vitepress___@vue_devtools-api.js
- vitepress___@vue_devtools-api.js.map
- vitepress___@vueuse_core.js
- vitepress___@vueuse_core.js.map
- vitepress___@vueuse_integrations_useFocusTrap.js
- vitepress___@vueuse_integrations_useFocusTrap.js.map
- vitepress___mark__js_src_vanilla__js.js
- vitepress___mark__js_src_vanilla__js.js.map
- vitepress___minisearch.js
- vitepress___minisearch.js.map
- vue.js
- vue.js.map
- custom.css
- index.ts
- config.ts
- ts-logo-128.png
- ts-logo-round-128.png
- tspec-icon-128.png
- tspec-icon-256.png
- api-test-1.png
- api-test-2.png
- api-test-3.png
- authorization-popup.png
- authorization-request.png
- authorize-button.png
- crud-swagger-ui.png
- file-download.png
- file-upload.png
- getting-started-swagger-ui-1.png
- getting-started-swagger-ui-2.png
- api-testing.md
- authentication.md
- cli.md
- crud-api-example.md
- defining-api-spec.md
- describing-schema.md
- express-integration.md
- file-upload-download.md
- generating-document.md
- getting-started.md
- index.md
- nestjs-integration.md
- troubleshooting.md
- tspec-config.md
- api-testing.md
- authentication.md
- crud-api-example.md
- defining-api-spec.md
- describing-schema.md
- express-integration.md
- file-upload-download.md
- generating-document.md
- getting-started.md
- nestjs-integration.md
- troubleshooting.md
- index.md
- introduction.md
- api-testing.md
- authentication.md
- crud-api-example.md
- defining-api-spec.md
- describing-schema.md
- express-integration.md
- file-upload-download.md
- generating-document.md
- getting-started.md
- nestjs-integration.md
- troubleshooting.md
- index.md
- introduction.md
- api-testing.md
- authentication.md
- crud-api-example.md
- defining-api-spec.md
- describing-schema.md
- express-integration.md
- file-upload-download.md
- generating-document.md
- getting-started.md
- nestjs-integration.md
- troubleshooting.md
- index.md
- introduction.md
- .gitignore
- api-examples.md
- index.md
- introduction.md
- markdown-examples.md
- package.json
- yarn.lock
- index.ts
- openapi.json
- .gitignore
- package.json
- tsconfig.json
- tspec.config.json
- yarn.lock
- index.ts
- openapi.json
- package.json
- tsconfig.json
- yarn.lock
- book.dto.ts
- books.controller.ts
- openapi.json
- package.json
- tsconfig.json
- index.ts
- openapi.json
- package.json
- tsconfig.json
- yarn.lock
- index.ts
- openapi.json
- package.json
- tsconfig.json
- yarn.lock
- index.ts
- config.ts
- index.ts
- openapiGenerator.ts
- openapiSchemaConverter.ts
- schemaBuilder.ts
- schemaParser.ts
- types.ts
- generator.ts
- index.ts
- openapiGenerator.ts
- parser.ts
- types.ts
- index.ts
- testUtils.ts
- books.controller.ts
- files.controller.ts
- tsconfig.json
- users.controller.ts
- parser.test.ts
- schema.test.ts
- expected.json
- spec.ts
- expected.json
- spec.ts
- expected.json
- spec.ts
- expected.json
- spec.ts
- expected.json
- spec.ts
- expected.json
- spec.ts
- expected.json
- spec.ts
- expected.json
- spec.ts
- expected.json
- spec.ts
- expected.json
- spec.ts
- expected.json
- spec.ts
- cli.test.ts
- generator.test.ts
- memory-leak.test.ts
- schema-generation.test.ts
- schemaBuilder.test.ts
- index.ts
- json-schema-to-openapi-schema.d.ts
- tspec.ts
- merge.ts
- types.ts
- index.ts
- .eslintrc.js
- .gitignore
- .npmignore
- LICENSE
- package.json
- README.md
- rollup.config.ts
- tsconfig.json
- vitest.config.ts
- yarn.lock
- .gitignore
- README.md
# 설치 가이드
1. 코드 내려받기
git clone https://github.com/ts-spec/tspec
깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.
cd tspec
방금 내려받은 프로젝트 폴더 안으로 이동합니다.
2. Node.js
쉬움 추천사전 준비물
⚠️ 이 프로젝트는 규모가 큰 저장소라, 이 방법이 실제 핵심 제품이 아니라 내부 하위 패키지를 가리키는 것일 수 있습니다. README 전체를 함께 확인해보세요.
cd packages/tspec
이 프로젝트의 관련 파일이 하위 폴더 안에 있어서, 먼저 그 폴더로 이동합니다.
npm install
package.json에 명시된 라이브러리들을 내려받아 설치합니다.
npm start
개발/실행 서버를 켭니다.
명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.
// repository documentation
Was this content helpful?
(0 ratings)
