rswag
Seamlessly adds a Swagger to Rails-based API's
파일 탐색기
최종 버전 다운로드 (.zip)- bug_report.md
- config.yml
- feature_request.md
- deploy-rswag.yml
- rubocop.yml
- ruby.yml
- spellcheck.yml
- dependabot.yml
- pull_request_template.md
- stale.yml
- build.sh
- test.sh
- install_generator.rb
- USAGE
- railtie.rb
- rswag.rb
- routes.rb
- .gitkeep
- install_generator_spec.rb
- MIT-LICENSE
- rswag.gemspec
- rails
- rswag_api.rb
- install_generator.rb
- USAGE
- configuration.rb
- engine.rb
- middleware.rb
- api.rb
- .gitkeep
- routes.rb
- install_generator_spec.rb
- configuration_spec.rb
- api_spec.rb
- routes.rb
- openapi.json
- openapi.yml
- middleware_spec.rb
- spec_helper.rb
- .rspec
- MIT-LICENSE
- Rakefile
- rswag-api.gemspec
- spec.rb.erb
- openapi_generator.rb
- USAGE
- openapi_helper.rb
- install_generator.rb
- USAGE
- configuration.rb
- example_group_helpers.rb
- example_helpers.rb
- extended_schema.rb
- openapi_formatter.rb
- railtie.rb
- request_factory.rb
- response_validator.rb
- route_parser.rb
- specs.rb
- rswag-specs_tasks.rake
- .gitkeep
- openapi_generator_spec.rb
- .gitkeep
- install_generator_spec.rb
- configuration_spec.rb
- example_group_helpers_spec.rb
- example_helpers_spec.rb
- openapi_formatter_spec.rb
- request_factory_spec.rb
- response_validator_spec.rb
- route_parser_spec.rb
- specs_spec.rb
- openapi_helper.rb
- spec_helper.rb
- .rspec
- .rubocop_rspec_alias_config.yml
- MIT-LICENSE
- Rakefile
- rswag-specs.gemspec
- rails
- custom_generator.rb
- USAGE
- rswag_ui.rb
- install_generator.rb
- USAGE
- basic_auth.rb
- configuration.rb
- engine.rb
- index.erb
- middleware.rb
- ui.rb
- rswag-ui_tasks.rake
- .gitkeep
- routes.rb
- custom_generator_spec.rb
- install_generator_spec.rb
- configuration_spec.rb
- spec_helper.rb
- .rspec
- MIT-LICENSE
- package-lock.json
- package.json
- Rakefile
- rswag-ui.gemspec
- manifest.js
- .keep
- stubs.js
- stubs.css
- application_controller.rb
- auth_tests_controller.rb
- blogs_controller.rb
- stubs_controller.rb
- stubs_helper.rb
- .gitkeep
- blog.rb
- development.rb
- test.rb
- backtrace_silencers.rb
- inflections.rb
- mime_types.rb
- rswag-api.rb
- rswag-ui.rb
- secret_token.rb
- session_store.rb
- wrap_parameters.rb
- application.rb
- boot.rb
- database.yml
- environment.rb
- routes.rb
- 20160218212104_create_blogs.rb
- schema.rb
- openapi.json
- .gitkeep
- thumbnail.png
- 404.html
- 422.html
- 500.html
- favicon.ico
- rails
- openapi_ui_spec.rb
- thumbnail.png
- auth_tests_spec.rb
- blogs_spec.rb
- rswag_specs_swaggerize_spec.rb
- openapi_helper.rb
- rails_helper.rb
- spec_helper.rb
- .rspec
- config.ru
- Rakefile
- traverse-secret.yml
- .dockerignore
- .gitignore
- .rubocop.yml
- .rubocop_todo.yml
- CHANGELOG.md
- CONTRIBUTING.md
- cspell.json
- docker-compose.yml
- Dockerfile
- Gemfile
- Makefile
- MIT-LICENCE
- README.md
- SECURITY.md
🚀 설치 가이드
1. 코드 내려받기
git clone https://github.com/rswag/rswag
깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.
cd rswag
방금 내려받은 프로젝트 폴더 안으로 이동합니다.
2. Docker
쉬움 추천사전 준비물
- Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
- Docker Desktop 컨테이너를 빌드하고 실행하려면 필요합니다. 설치 후 실행해서 백그라운드에 켜두세요.
docker pull swaggerapi/swagger-editor
이 명령어를 터미널에 그대로 입력해 실행하세요.
docker run -d -p 80:8080 swaggerapi/swagger-editor
빌드된 이미지를 실제 컨테이너로 실행합니다.
터미널에 docker compose ps 를 입력해 컨테이너들이 Up 상태인지 확인하세요. README에 포트 번호가 적혀있다면 브라우저에서 http://localhost:포트번호 로 접속해보세요.
이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.
3. Node.js
쉬움사전 준비물
cd rswag-ui
이 프로젝트의 관련 파일이 하위 폴더 안에 있어서, 먼저 그 폴더로 이동합니다.
npm install
package.json에 명시된 라이브러리들을 내려받아 설치합니다.
npm start
개발/실행 서버를 켭니다.
명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.
4. Ruby
쉬움bundle exec rake rswag:ui:copy_assets[public/api-docs]
이 명령어를 터미널에 그대로 입력해 실행하세요.
bundle install이 에러 없이 끝나면 README에 안내된 실행 명령어(예: rails server)로 마저 실행해보세요.
이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.
5. Make
보통사전 준비물
- Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
- Make Linux/macOS는 보통 기본 설치되어 있습니다. Windows는 별도 설치(예: MSYS2, WSL)가 필요합니다.
make
생성된 빌드 설정을 바탕으로 실제 컴파일을 진행해 실행 파일을 만듭니다.
에러 없이 끝나면 성공입니다. 생성된 실행 파일을 직접 실행해보세요.
// repository documentation
Was this content helpful?
(0 ratings)