payload-oapi

(★ 123)

A Payload CMS plugin for OpenAPI (3.0, 3.1) specification generation

파일 탐색기

- - check.yml
  - release.yml
- - Pages.ts
  - Pets.ts
  - Posts.ts
  - Users.ts
- - FeaturedPet.ts
- - credentials.ts
  - NextRESTClient.ts
  - testEmailAdapter.ts
- .env.example
- docker-compose.yml
- next-env.d.ts
- next.config.mjs
- payload-types.ts
- payload.config.ts
- seed.ts
- server.ts
- tsconfig.json
- - generators.ts
  - naming.ts
  - securitySchemes.ts
- - fields.ts
  - filters.ts
  - objects.ts
  - strings.ts
- index.ts
- openapiPlugin.ts
- rapidocPlugin.ts
- redocPlugin.ts
- requestHandlers.ts
- scalarPlugin.ts
- swaggerUIPlugin.ts
- types.ts
- - openapi-generators.test.ts.snap
- openapi-generators.test.ts
- tsconfig.json
.editorconfig
.gitignore
biome.json
CHANGELOG.md
cliff.toml
LICENSE.md
package.json
README.md
tsconfig.json
yarn.lock

1. 코드 내려받기

git clone https://github.com/janbuchar/payload-oapi

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

cd payload-oapi

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

쉬움 추천

사전 준비물

docker compose -f dev/docker-compose.yml up -d --build

compose 설정 파일에 정의된 서비스들을 대상으로 명령을 실행합니다.

✅ 터미널에 docker compose ps 를 입력해 컨테이너들이 Up 상태인지 확인하세요. README에 포트 번호가 적혀있다면 브라우저에서 http://localhost:포트번호 로 접속해보세요.

쉬움

사전 준비물

npm install

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

npm start

개발/실행 서버를 켭니다.

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