azure-rest-adventure
Advanced tools
go on a RESTful adventure to create a service on azure
A learning adventure that teaches how to write restful services and how to deploy those services to azure.
The goal of this adventure is to teach you how to build a RESTful service that runs on azure and works like a key-value store. That is, it supports storing data that matches the following format:
{
name: "unique name",
value: "any value"
}
It will support creating new items, listing items, querying specific items, and removing items.
npm install -g azure-rest-adventureazure-rest-adventure or azradv for shortThis is what you see when you run
azradv
The list shows all the different segments of the lesson, listed in the order they should be completed. Selecting an entry (by hitting enter with it highlighted) outputs a description of the problem you'll need to solve for that portion of the lesson, as well as a description of how to verify that you've successfully completed it.
After a lesson is completed, run azradv again to select
the next lesson.
The setup lesson is where we configure our nodejs project. You'll be asked to setup a directory for the project, configure the project (by creating a package.json file) and install dependencies.
To verify completion, we'll ask you to pass the directory
name (yes, you can pass . as the path) that your project
lives in, so we can check for the following things:
The scaffolded lesson is where we define our core logic
for the project. You'll be asked to create an entrypoint
(this is the file referenced in the above step in package.json#main)
that creates an express app and starts listening on port 3000.
To verify completion, we'll ask you to pass the entrypoint file path so we can start your application and check for the following things:
Todo: we should also validate that the application is actually listening
The postone lesson is where we define our first RESTful endpoint
for the project. You'll be asked to create an endpoint at
/items that's capable of receiving the following in the request body:
{
name: "some string",
value: "some string"
}
And responds with a 200 on success, a 400 when the request is malformed,
and a 500 when an internal error occurs.
To verify completion, we'll ask you to pass the entrypoint file path so we can start your application and check for the following things:
HTTP POST /items with a valid bodyThe postmany lesson is where we define a new RESTful endpoint
for the project. You'll be asked to create an endpoint at
/items that's capable of receiving the following in the request body:
Where
...indicates 0-N additional objects that match that format.
[{
name: "some string",
value: "some string"
}, ...]
And responds with a 200 on success, a 400 when the request is malformed,
and a 500 when an internal error occurs.
To verify completion, we'll ask you to pass the entrypoint file path so we can start your application and check for the following things:
HTTP POST /items with a valid bodyThe getone lesson is where we define a new RESTful endpoint
for the project. You'll be asked to create an endpoint at
/items/:name that's capable of responding with a given
item if that item exists.
It responds with a 200 and the following body on success:
{
name: "the passed name value",
value: "some value"
}
a 400 when the request is malformed,
a 404 when no such item is found,
and finally a 500 when an internal error occurs.
To verify completion, we'll ask you to pass the entrypoint file path so we can start your application and check for the following things:
HTTP GET /items/item-name and returns a valid response bodyHTTP GET /items/no-such-item and returns a 404 status codeThe getmany lesson is where we define a new RESTful endpoint
for the project. You'll be asked to create an endpoint at
/items that's capable of responding with a given
item if that item exists.
It responds with a 200 and the following body on success:
Where
...indicates 0-N additional objects that match that format.
[{
name: "the passed name value",
value: "some value"
}, ...]
a 400 when the request is malformed,
and finally a 500 when an internal error occurs.
To verify completion, we'll ask you to pass the entrypoint file path so we can start your application and check for the following things:
HTTP GET /items and returns a valid response bodyHTTP POST /items to create an item,
followed by HTTP GET /items to enumerate all items, including the newly created one.The deleteone lesson is where we define a new RESTful endpoint
for the project. You'll be asked to create an endpoint at
/items/:name that's capable of removing that item if it exists.
It responds with a 200 on success,
a 400 when the request is malformed,
a 404 when no such item is found,
and finally a 500 when an internal error occurs.
To verify completion, we'll ask you to pass the entrypoint file path so we can start your application and check for the following things:
HTTP DELETE /items/item-name and returns a valid response bodyHTTP POST /items to create an item,
followed by HTTP DELETE /items/item-name to create and then delete an item.The deletemany lesson is where we define a new RESTful endpoint
for the project. You'll be asked to create an endpoint at
/items that's capable of removing all items.
It responds with a 200 when items are removed,
a 400 when the request is malformed,
a 404 when no items exists,
and finally a 500 when an internal error occurs.
To verify completion, we'll ask you to pass the entrypoint file path so we can start your application and check for the following things:
HTTP DELETE /items and returns a valid responseHTTP POST /items to create a few items,
followed by HTTP DELETE /items to create and then delete items.The azure lesson is where we deploy the service to azure and validate it's functioning there. You'll be asked to deploy to azure.
To verify completion, we'll ask you to pass the url to your azure service
(including protocol, like http://) and test the following requests:
<one item><many items>MIT
FAQs
go on a RESTful adventure to create a service on azure
The npm package azure-rest-adventure receives a total of 1 weekly downloads. As such, azure-rest-adventure popularity was classified as not popular.
We found that azure-rest-adventure demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.