The Getting Started tutorial for the OpenAPI Specification (OAS) uses this sample application to provide you with a sample workflow for working with OpenAPI; you set up a development environment, deploy an app locally and start playing with OpenAPI.
It is based on the Node.js getting started application. It is modified to use an internal cache to facilitate information to be added and returned to the UI instead of a database. The APIs have also been updated to reflect REST API CRUD operations.
The following steps are the general procedure to set up your app and take on the API experience and its challenges.
The following prerequisites are required:
It is recommended to use a Linux OS that is not your host machine. The challenges have been tested using Ubuntu 16.04.4.
- Clone the sample app GitHub repo.
git clone git@github.com:IBM/get-started-openapi.git
- On the command line, change the directory to where the sample app is located.
cd get-started-openapi
- Install the dependencies listed in the package.json to run the app locally.
npm install
- Run the app.
npm start
You should be able to view the app at http://localhost:3000, and add and view entries.
Now that you have set-up your development environment, it is time to "kick the tires" by jumping into the OpenAPI Experience. Good luck!
This is a v1 release of the guide and we plan to continue improving it. We would love feedback. If you have any suggestions or find a defect with the code, please open an issue or submit a Pull Request to the repository.