https://github.com/intersystems/isc-rest
https://github.com/intersystems/isc-rest
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/intersystems/isc-rest
- Owner: intersystems
- License: mit
- Created: 2022-03-22T19:59:06.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-12-17T21:46:57.000Z (7 months ago)
- Last Synced: 2025-12-21T09:18:06.052Z (6 months ago)
- Language: ObjectScript
- Size: 310 KB
- Stars: 4
- Watchers: 8
- Forks: 4
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# isc.rest
A framework for building secure REST APIs to existing persistent classes and
business logic in the InterSystems IRIS Data Platform.
- [Getting Started](#getting-started)
- [Installation: ZPM](#installation-zpm)
- [Tutorial](#tutorial)
- [User Guide](#user-guide)
- [Technical/Troubleshooting Guide](#technicaltroubleshooting-guide)
- [Support](#support)
## Getting Started
Note: a minimum platform version of InterSystems IRIS 2018.1 is required.
### Installation: ZPM
If you already have the [ObjectScript Package Manager](https://openexchange.intersystems.com/package/ObjectScript-Package-Manager-2), installation is as easy as:
```
zpm "install isc.rest"
```
### Tutorial
For a step-by-step tutorial, see [isc.rest Tutorial and Sample Application: Contact List](./docs/sample-phonebook.md).
## User Guide
See [isc.rest User Guide](./docs/user-guide.md).
## Technical/Troubleshooting Guide
See [isc.rest Technical/Troubleshooting Guide](./docs/troubleshooting.md).
## Support
If you find a bug or would like to request an enhancement, [report an issue](https://github.com/intersystems/isc-rest/issues/new). If you have a question, feel free to post it on the [InterSystems Developer Community](https://community.intersystems.com/).
## Contributing
Please read [contributing](https://github.com/intersystems/isc-rest/blob/master/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
## Versioning
We use [SemVer](http://semver.org/) for versioning. Declare your dependencies using the community package manager for the appropriate level of risk.
## Authors
* **Tim Leavitt** - *Initial implementation* - [isc-tleavitt](http://github.com/isc-tleavitt)
See also the list of [contributors](https://github.com/intersystems/isc-rest/graphs/contributors) who participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE](https://github.com/intersystems/isc-rest/blob/master/LICENSE) file for details.