ced7f16645
The OpenAPI Specification (formerly known as the Swagger RESTful API Documentation Specification) defines a format for describing RESTful APIs. The Swagger project provides a set of tools for working with this format, including a hosted validator which provides a validation badge and JSON result.[1] This commit adds shields.io support for this badge. The service currently only provides validation of files conforming to version 2.0 of the OpenAPI Specification. This commit adds a path component for specifying the version under the assumption that the validator may support version 3.0 or later as they are released. It accepts the URL to validate as two path components, a scheme followed by the rest of the URL, to match the convention used for the JIRA host and webpage online shields. Changes in v2: - Use bitbucket in try.html example for clarity. - Change /v/ in URL to /valid/ to avoid conflict with v=version. 1. https://github.com/swagger-api/validator-badge Signed-off-by: Kevin Locke <kevin@kevinlocke.name> |
||
|---|---|---|
| lib | ||
| logo | ||
| public | ||
| spec | ||
| templates | ||
| test | ||
| .buildpacks | ||
| .dockerignore | ||
| .editorconfig | ||
| .eslintrc.yml | ||
| .gitignore | ||
| .travis.yml | ||
| CNAME | ||
| CONTRIBUTING.md | ||
| coverage.svg | ||
| Dockerfile | ||
| favicon.png | ||
| gh-badge.js | ||
| index.html | ||
| INSTALL.md | ||
| LICENSE.md | ||
| logo.svg | ||
| Makefile | ||
| package.json | ||
| README.md | ||
| server.js | ||
| try.html | ||
An image server for legible and concise information. Our Homepage | Twitter
- INSTALL – installation instructions.
- CONTRIBUTING – project contribution guidelines.
- SPECIFICATION – spec for the visual design of Shields badges.
- LICENSE – public domain dedication.
Make your own badges here! (Quick guide: https://img.shields.io/badge/left-right-f39f37.svg.)
Solving the problem
Many GitHub repositories sport badges for things like:
| Travis CI (build status) |
 |
| Gemnasium (dependency checks) |
 |
| Code Climate (static analysis) |
 |
| RubyGems (released gem version) |
 |
As you can see from the zoomed 400% versions of these badges above, nobody is (really) using the same badge file and at normal size, they're hardly legible. Worst of all, they're completely inconsistent. The information provided isn't of the same kind on each badge. The context is blurry, which doesn't make for a straightforward understanding of how these badges are relevant to the project they're attached to and what information they provide.
The Shields solution
As you can see below, without increasing the footprint of these badges, I've tried to increase legibility and coherence, removing useless text to decrease the horizontal length in the (likely) scenario that more of these badge thingies crop up on READMEs all across the land.
This badge design corresponds to an old and now deprecated version which has since been replaced by beautiful and scalable SVG versions that can be found on shields.io.
Examples
What kind of metadata can you convey using badges?
- test build status:
build | failing - code coverage percentage:
coverage | 80% - stable release version:
version | 1.2.3 - package manager release:
gem | 1.2.3 - status of third-party dependencies:
dependencies | out-of-date - static code analysis GPA:
code climate | 3.8 - SemVer version observance:
semver | 2.0.0 - amount of Gratipay donations per week:
tips | $2/week
Services using the Shields standard
- Badger
- badges2svg
- CII Best Practices
- Codacy
- Code Climate
- Coveralls
- docs.rs
- Forkability
- Gemnasium
- GoDoc
- PHPPackages
- Read the Docs
- reposs
- ruby-gem-downloads-badge
- Scrutinizer
- Semaphore
- Travis CI
- Version Badge
- VersionEye
Legal
All assets and code are under the CC0 LICENSE and in the public domain unless specified otherwise.
The assets in logo/ are trademarks of their respective companies and are under
their terms and license.