https://github.com/speciesfilegroup/taxonworks_api
Documentation for TaxonWorks APIs
https://github.com/speciesfilegroup/taxonworks_api
api json taxonworks
Last synced: about 1 year ago
JSON representation
Documentation for TaxonWorks APIs
- Host: GitHub
- URL: https://github.com/speciesfilegroup/taxonworks_api
- Owner: SpeciesFileGroup
- License: other
- Created: 2017-12-05T03:42:42.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2023-04-03T20:39:02.000Z (about 3 years ago)
- Last Synced: 2025-04-11T18:23:39.424Z (about 1 year ago)
- Topics: api, json, taxonworks
- Language: RAML
- Homepage: http://api.taxonworks.org
- Size: 4.08 MB
- Stars: 2
- Watchers: 12
- Forks: 7
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://github.com/SpeciesFileGroup/taxonworks_api/actions?query=workflow%3Adocs)
# taxonworks_api
Documentation for the [TaxonWorks](http://taxonworks.org) workbench API, served at [https://api.taxonworks.org](https://api.taxonworks.org). Application code is [here](https://github.com/SpeciesFileGroup/taxonworks).
## Building
Documentation uses RAML, it is built with [gulp](https://gulpjs.com/):
Clone this repository, then:
```
npm install
npx gulp apidoc
```
Documentation is in `/docs`. Open `/docs/index.html` to view locally, or see [running an api console](https://api.taxonworks.org/#/running-an-api-console).
## Deploying
Merge `development` into `main`. Github actions do the rest.
## Changelog
See [CHANGELOG.md](/CHANGELONG.md). Note this changelog documents changes in the documentation, not the underlying code.
## Contributing
See [CONTRIBUTING.md](/CONTRIBUTING.md).
## License
[https://opensource.org/licenses/NCSA](/LICENSE.md).
## Code of conduct
Please see [CODE_OF_CONDUCT.md](/CODE_OF_CONDUCT.md).