speccy
Well Spectually π€ Enforce quality rules on your OpenAPI 3.0.x specifications.
νμΌ νμκΈ°
μ΅μ’ λ²μ λ€μ΄λ‘λ (.zip)- config.yml
- ISSUE_TEMPLATE.md
- rules.yml
- footer.html
- google-analytics.html
- head.html
- rules-list.html
- sidenav.html
- default.html
- home.html
- page.html
- _alert.scss
- _background-variant.scss
- _badge.scss
- _border-radius.scss
- _box-shadow.scss
- _breakpoints.scss
- _buttons.scss
- _caret.scss
- _clearfix.scss
- _float.scss
- _forms.scss
- _gradients.scss
- _grid-framework.scss
- _grid.scss
- _hover.scss
- _image.scss
- _list-group.scss
- _lists.scss
- _nav-divider.scss
- _navbar-align.scss
- _pagination.scss
- _reset-text.scss
- _resize.scss
- _screen-reader.scss
- _size.scss
- _table-row.scss
- _text-emphasis.scss
- _text-hide.scss
- _text-truncate.scss
- _transition.scss
- _visibility.scss
- _align.scss
- _background.scss
- _borders.scss
- _clearfix.scss
- _display.scss
- _embed.scss
- _flex.scss
- _float.scss
- _position.scss
- _screenreaders.scss
- _sizing.scss
- _spacing.scss
- _text.scss
- _visibility.scss
- _alert.scss
- _badge.scss
- _breadcrumb.scss
- _button-group.scss
- _buttons.scss
- _card.scss
- _carousel.scss
- _close.scss
- _code.scss
- _custom-forms.scss
- _dropdown.scss
- _forms.scss
- _functions.scss
- _grid.scss
- _images.scss
- _input-group.scss
- _jumbotron.scss
- _list-group.scss
- _media.scss
- _mixins.scss
- _modal.scss
- _nav.scss
- _navbar.scss
- _pagination.scss
- _popover.scss
- _print.scss
- _progress.scss
- _reboot.scss
- _root.scss
- _tables.scss
- _tooltip.scss
- _transitions.scss
- _type.scss
- _utilities.scss
- _variables.scss
- bootstrap.scss
- _bootstrap-overrides.scss
- _global.scss
- _mixins.scss
- _nav.scss
- _resume-item.scss
- _variables.scss
- resume.scss
- _base.scss
- _layout.scss
- speccy.jpg
- main.scss
- 1-rulesets.md.html
- 2-custom-rulesets.md
- devicons.css
- devicons.min.css
- devicons.scss
- devicons.eot
- devicons.svg
- devicons.ttf
- devicons.woff
- font-awesome.css
- font-awesome.min.css
- fontawesome-webfont.eot
- fontawesome-webfont.svg
- fontawesome-webfont.ttf
- fontawesome-webfont.woff
- fontawesome-webfont.woff2
- FontAwesome.otf
- animated.less
- bordered-pulled.less
- core.less
- fixed-width.less
- font-awesome.less
- icons.less
- larger.less
- list.less
- mixins.less
- path.less
- rotated-flipped.less
- screen-reader.less
- stacked.less
- variables.less
- _animated.scss
- _bordered-pulled.scss
- _core.scss
- _fixed-width.scss
- _icons.scss
- _larger.scss
- _list.scss
- _mixins.scss
- _path.scss
- _rotated-flipped.scss
- _screen-reader.scss
- _stacked.scss
- _variables.scss
- font-awesome.scss
- simple-line-icons.css
- Simple-Line-Icons.eot
- Simple-Line-Icons.svg
- Simple-Line-Icons.ttf
- Simple-Line-Icons.woff
- Simple-Line-Icons.woff2
- simple-line-icons.less
- simple-line-icons.scss
- .gitignore
- .tool-versions
- 404.html
- _config.yml
- CNAME
- Gemfile
- Gemfile.lock
- index.md
- package-lock.json
- Rakefile
- rules.html
- no-contact.yaml
- petstore.yaml
- config.js
- loader.js
- rules.js
- server.js
- default.yaml
- strict.yaml
- gnostic-3.0.json
- json_v5.json
- openapi-3.0.json
- index.html
- empty.yaml
- valid.json
- valid.yaml
- invalid-key.yaml
- missing-contact.yaml
- missing-ref.yaml
- a.json
- openapi.yaml
- b.yml
- a.yaml
- openapi.yaml
- parameters.yaml
- duplicates.yaml
- not-openapi.txt
- openapi.json
- openapi.yaml
- default.json
- strict.json
- lint.test.js
- config.test.js
- loader.test.js
- rules.test.js
- server.test.js
- .dockerignore
- .editorconfig
- .eslintrc.json
- .gitignore
- CHANGELOG.md
- CODE_OF_CONDUCT.md
- Dockerfile
- LICENSE
- lint.js
- package-lock.json
- package.json
- README.md
- resolve.js
- serve.js
- speccy.js
# μ€μΉ κ°μ΄λ
git clone https://github.com/wework/speccy
κΉνλΈμμ νλ‘μ νΈ μ½λ μ 체λ₯Ό λ΄ μ»΄ν¨ν°λ‘ λ΄λ €λ°μ΅λλ€.
cd speccy
λ°©κΈ λ΄λ €λ°μ νλ‘μ νΈ ν΄λ μμΌλ‘ μ΄λν©λλ€.
2. Docker
μ¬μ μΆμ²- Git GitHubμμ νλ‘μ νΈ μ½λλ₯Ό λ΄λ €λ°μΌλ €λ©΄ νμν©λλ€.
- Docker Desktop 컨ν μ΄λλ₯Ό λΉλνκ³ μ€ννλ €λ©΄ νμν©λλ€. μ€μΉ ν μ€νν΄μ λ°±κ·ΈλΌμ΄λμ μΌλμΈμ.
To use Speccy without installing any node/npm specific dependencies, you can run it via docker:
μ΄ λͺ λ Ήμ΄λ₯Ό ν°λ―Έλμ κ·Έλλ‘ μ λ ₯ν΄ μ€ννμΈμ.
Also, if you want to use a specific version, you can reference tags, so `docker run wework/speccy` could be `docker run wework/speccy:0`,
λΉλλ μ΄λ―Έμ§λ₯Ό μ€μ 컨ν μ΄λλ‘ μ€νν©λλ€.
`docker run wework/speccy:0.8` or `docker run wework/speccy:0.8.7`. These versions follow semantic versioning.
λΉλλ μ΄λ―Έμ§λ₯Ό μ€μ 컨ν μ΄λλ‘ μ€νν©λλ€.
μ΄ λ ν¬μ READMEμ μ ν μ€μ λͺ λ Ήμ΄λ₯Ό κ·Έλλ‘ κ°μ Έμμ΅λλ€.
3. Node.js
μ¬μ$ npm install speccy -g
package.jsonμ λͺ μλ λΌμ΄λΈλ¬λ¦¬λ€μ λ΄λ €λ°μ μ€μΉν©λλ€.
$ yarn global add speccy
μ΄ λͺ λ Ήμ΄λ₯Ό ν°λ―Έλμ κ·Έλλ‘ μ λ ₯ν΄ μ€ννμΈμ.
To use Speccy without installing any node/npm specific dependencies, you can run it via docker:
μ΄ λͺ λ Ήμ΄λ₯Ό ν°λ―Έλμ κ·Έλλ‘ μ λ ₯ν΄ μ€ννμΈμ.
μ΄ λ ν¬μ READMEμ μ ν μ€μ λͺ λ Ήμ΄λ₯Ό κ·Έλλ‘ κ°μ Έμμ΅λλ€.
