-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
The getting started section will contain basic examples using curl. This will serve as a basic tutorial to those not familiar with interacting with rest apis
- Loading branch information
Showing
4 changed files
with
42 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
Step by Step | ||
============ | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
:name: toc-learn-step-by-step | ||
|
||
prereq | ||
yougotmail |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
.. _doc_curl_prerq | ||
Prerequisites | ||
============= | ||
|
||
There are only two programs you need to get started `curl <https://curl.haxx.se/>`_ and | ||
`jq <https://stedolan.github.io/jq/>`_ . If you are using linux or OSX curl is most likely | ||
already installed. The `jq download <https://stedolan.github.io/jq/download/>`_ page provides | ||
installation instructions for most operating systems. | ||
|
||
.. code-block:: bash | ||
:caption: For operating systems using yum | ||
$sudo yum install curl jq -y | ||
.. code-block:: bash | ||
:caption: For operating system using apt | ||
$sudo apt-get install jq curl -y | ||
.. tip:: Windows users can use `chocolatey <https://chocolatey.org/>`_ to install jq and curl | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
.. _doc_yougotmail | ||
You Got Mail! | ||
============= |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters