API_Basics.ipynb

{
  "nbformat": 4,
  "nbformat_minor": 0,
  "metadata": {
    "colab": {
      "name": "API_Basics",
      "provenance": [],
      "collapsed_sections": [],
      "include_colab_link": true
    },
    "kernelspec": {
      "name": "python3",
      "display_name": "Python 3"
    }
  },
  "cells": [
    {
      "cell_type": "markdown",
      "metadata": {
        "id": "view-in-github",
        "colab_type": "text"
      },
      "source": [
        "<a href=\"https://colab.research.google.com/github/ialimustufa/API/blob/main/API_Basics.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>"
      ]
    },
    {
      "cell_type": "markdown",
      "metadata": {
        "id": "pA5fJ-mhtyDH"
      },
      "source": [
        "# Use [Postman](https://postman.com) to Test this API.\r\n",
        "\r\n",
        "Fork this [Public Workspace](https://www.postman.com/iali-dev/workspace/getting-hands-dirty-with-apis/) and get started."
      ]
    },
    {
      "cell_type": "code",
      "metadata": {
        "id": "KRilgOjLt7mS",
        "colab": {
          "base_uri": "https://localhost:8080/"
        },
        "outputId": "7b071a74-15e6-4ce3-90d0-ee87e8d109a7"
      },
      "source": [
        "!pip install flask-restful\r\n",
        "!pip install flask-ngrok"
      ],
      "execution_count": 13,
      "outputs": [
        {
          "output_type": "stream",
          "text": [
            "Requirement already satisfied: flask-restful in /usr/local/lib/python3.6/dist-packages (0.3.8)\n",
            "Requirement already satisfied: pytz in /usr/local/lib/python3.6/dist-packages (from flask-restful) (2018.9)\n",
            "Requirement already satisfied: aniso8601>=0.82 in /usr/local/lib/python3.6/dist-packages (from flask-restful) (8.1.1)\n",
            "Requirement already satisfied: Flask>=0.8 in /usr/local/lib/python3.6/dist-packages (from flask-restful) (1.1.2)\n",
            "Requirement already satisfied: six>=1.3.0 in /usr/local/lib/python3.6/dist-packages (from flask-restful) (1.15.0)\n",
            "Requirement already satisfied: click>=5.1 in /usr/local/lib/python3.6/dist-packages (from Flask>=0.8->flask-restful) (7.1.2)\n",
            "Requirement already satisfied: itsdangerous>=0.24 in /usr/local/lib/python3.6/dist-packages (from Flask>=0.8->flask-restful) (1.1.0)\n",
            "Requirement already satisfied: Jinja2>=2.10.1 in /usr/local/lib/python3.6/dist-packages (from Flask>=0.8->flask-restful) (2.11.3)\n",
            "Requirement already satisfied: Werkzeug>=0.15 in /usr/local/lib/python3.6/dist-packages (from Flask>=0.8->flask-restful) (1.0.1)\n",
            "Requirement already satisfied: MarkupSafe>=0.23 in /usr/local/lib/python3.6/dist-packages (from Jinja2>=2.10.1->Flask>=0.8->flask-restful) (1.1.1)\n",
            "Requirement already satisfied: flask-ngrok in /usr/local/lib/python3.6/dist-packages (0.0.25)\n",
            "Requirement already satisfied: Flask>=0.8 in /usr/local/lib/python3.6/dist-packages (from flask-ngrok) (1.1.2)\n",
            "Requirement already satisfied: requests in /usr/local/lib/python3.6/dist-packages (from flask-ngrok) (2.23.0)\n",
            "Requirement already satisfied: click>=5.1 in /usr/local/lib/python3.6/dist-packages (from Flask>=0.8->flask-ngrok) (7.1.2)\n",
            "Requirement already satisfied: Jinja2>=2.10.1 in /usr/local/lib/python3.6/dist-packages (from Flask>=0.8->flask-ngrok) (2.11.3)\n",
            "Requirement already satisfied: Werkzeug>=0.15 in /usr/local/lib/python3.6/dist-packages (from Flask>=0.8->flask-ngrok) (1.0.1)\n",
            "Requirement already satisfied: itsdangerous>=0.24 in /usr/local/lib/python3.6/dist-packages (from Flask>=0.8->flask-ngrok) (1.1.0)\n",
            "Requirement already satisfied: chardet<4,>=3.0.2 in /usr/local/lib/python3.6/dist-packages (from requests->flask-ngrok) (3.0.4)\n",
            "Requirement already satisfied: certifi>=2017.4.17 in /usr/local/lib/python3.6/dist-packages (from requests->flask-ngrok) (2020.12.5)\n",
            "Requirement already satisfied: urllib3!=1.25.0,!=1.25.1,<1.26,>=1.21.1 in /usr/local/lib/python3.6/dist-packages (from requests->flask-ngrok) (1.24.3)\n",
            "Requirement already satisfied: idna<3,>=2.5 in /usr/local/lib/python3.6/dist-packages (from requests->flask-ngrok) (2.10)\n",
            "Requirement already satisfied: MarkupSafe>=0.23 in /usr/local/lib/python3.6/dist-packages (from Jinja2>=2.10.1->Flask>=0.8->flask-ngrok) (1.1.1)\n"
          ],
          "name": "stdout"
        }
      ]
    },
    {
      "cell_type": "code",
      "metadata": {
        "id": "I6fiuo8-wngz",
        "colab": {
          "base_uri": "https://localhost:8080/"
        },
        "outputId": "d6e3d6df-02c5-4522-e937-e61dcbd0479a"
      },
      "source": [
        "from flask import Flask, jsonify\r\n",
        "from flask_restful import Api, Resource, reqparse\r\n",
        "from flask_ngrok import run_with_ngrok\r\n",
        "from flask import make_response\r\n",
        "\r\n",
        "\r\n",
        "import random\r\n",
        "app = Flask(__name__)\r\n",
        "api = Api(app)\r\n",
        "\r\n",
        "dev_jokes = [\r\n",
        "    {\r\n",
        "        \"id\": 0,\r\n",
        "        \"author\": \"NA\",\r\n",
        "        \"joke\": \"Q: How did the Coder CEO build his company headquarters? A: By calling the Constructor();\", \r\n",
        "        \"source\": \"https://github.com/shrutikapoor08/devjoke/blob/master/README.md\"\r\n",
        "    },\r\n",
        "    {\r\n",
        "        \"id\": 1,\r\n",
        "        \"author\": \"NA\",\r\n",
        "        \"joke\": \"Q: What is Hardware? A: The part of the computer which you can kick.\",\r\n",
        "        \"source\": \"https://github.com/shrutikapoor08/devjoke/blob/master/README.md\"\r\n",
        "    },\r\n",
        "    {\r\n",
        "        \"id\": 2,\r\n",
        "        \"author\": \"NA\",\r\n",
        "        \"joke\": \"Q: Who is a programmer? A: A programmer is a machine who turns coffee into code.\",\r\n",
        "        \"source\": \"https://github.com/shrutikapoor08/devjoke/blob/master/README.md\"\r\n",
        "    },\r\n",
        "    {\r\n",
        "        \"id\": 3,\r\n",
        "        \"author\": \"NA\",\r\n",
        "        \"joke\": \"First rule of programming : If it works DON'T touch it.\",\r\n",
        "        \"source\": \"https://github.com/shrutikapoor08/devjoke/blob/master/README.md\"\r\n",
        "    }\r\n",
        "]\r\n",
        "\r\n",
        "class joke(Resource):\r\n",
        "    def get(self, id=0):\r\n",
        "        if not id:\r\n",
        "            return random.choice(dev_jokes), 200\r\n",
        "        for joke in dev_jokes:\r\n",
        "            if(joke[\"id\"] == id):\r\n",
        "                return joke, 200\r\n",
        "        return \"Joke not found\", 404\r\n",
        "      \r\n",
        "    def post(self):\r\n",
        "      parser = reqparse.RequestParser()\r\n",
        "      parser.add_argument(\"id\",type=int,required=True)\r\n",
        "      parser.add_argument(\"author\",required=True)\r\n",
        "      parser.add_argument(\"joke\",required=True)\r\n",
        "      parser.add_argument(\"source\")\r\n",
        "      params = parser.parse_args()\r\n",
        "      id = params[\"id\"]\r\n",
        "      for joke in dev_jokes:\r\n",
        "          if(id == joke[\"id\"]):\r\n",
        "              return f\"Joke with id {id} already exists add new id\", 400\r\n",
        "      joke = {\r\n",
        "          \"id\": int(id),\r\n",
        "          \"author\": params[\"author\"],\r\n",
        "          \"joke\": params[\"joke\"],\r\n",
        "          \"source\": params[\"source\"]\r\n",
        "      }\r\n",
        "      dev_jokes.append(joke)\r\n",
        "      return joke, 201\r\n",
        "\r\n",
        "    def delete(self, id='c'):\r\n",
        "        if id is 'c':\r\n",
        "          return make_response(jsonify({'error': 'ID is missing'}), 400)\r\n",
        "        global dev_jokes\r\n",
        "        dev_jokes = [joke for joke in dev_jokes if joke[\"id\"] != id]\r\n",
        "        return f\"Joke with id {id} is deleted.\", 200\r\n",
        "\r\n",
        "    def put(self):\r\n",
        "      parser = reqparse.RequestParser()\r\n",
        "      parser.add_argument(\"id\",type=int,required=True)\r\n",
        "      parser.add_argument(\"author\",required=True)\r\n",
        "      parser.add_argument(\"joke\",required=True)\r\n",
        "      parser.add_argument(\"source\")      \r\n",
        "      params = parser.parse_args()\r\n",
        "      id = params[\"id\"]\r\n",
        "      for obj in dev_jokes:\r\n",
        "          if(id == obj[\"id\"]):\r\n",
        "              obj[\"author\"] = params[\"author\"]\r\n",
        "              obj[\"joke\"] = params[\"joke\"]\r\n",
        "              obj[\"source\"] = params[\"source\"]\r\n",
        "              return obj, 204\r\n",
        "      else:\r\n",
        "            return make_response(jsonify({'error': 'ID is not present in database'}), 404)\r\n",
        "    \r\n",
        "\r\n",
        "class home(Resource):\r\n",
        "  def get(self):\r\n",
        "    return \"Hey there! This is a simple demo for making an API server made by Ali Mustufa Shaikh;\"\r\n",
        "\r\n",
        "api.add_resource(joke, \"/joke\", \"/joke/\", \"/joke/<int:id>\")\r\n",
        "api.add_resource(home,\"/\")\r\n",
        "\r\n",
        "if __name__ == '__main__':\r\n",
        "    run_with_ngrok(app)\r\n",
        "    app.run()"
      ],
      "execution_count": 29,
      "outputs": [
        {
          "output_type": "stream",
          "text": [
            " * Serving Flask app \"__main__\" (lazy loading)\n",
            " * Environment: production\n",
            "\u001b[31m   WARNING: This is a development server. Do not use it in a production deployment.\u001b[0m\n",
            "\u001b[2m   Use a production WSGI server instead.\u001b[0m\n",
            " * Debug mode: off\n"
          ],
          "name": "stdout"
        },
        {
          "output_type": "stream",
          "text": [
            " * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)\n"
          ],
          "name": "stderr"
        },
        {
          "output_type": "stream",
          "text": [
            " * Running on http://8a8c014510c4.ngrok.io\n",
            " * Traffic stats available on http://127.0.0.1:4040\n"
          ],
          "name": "stdout"
        },
        {
          "output_type": "stream",
          "text": [
            "127.0.0.1 - - [07/Feb/2021 17:54:13] \"\u001b[37mPUT /joke HTTP/1.1\u001b[0m\" 204 -\n",
            "127.0.0.1 - - [07/Feb/2021 17:54:22] \"\u001b[33mPUT /joke HTTP/1.1\u001b[0m\" 404 -\n"
          ],
          "name": "stderr"
        }
      ]
    },
    {
      "cell_type": "markdown",
      "metadata": {
        "id": "Amk2qrdFB5Ua"
      },
      "source": [
        "## Advance Part\n",
        "\n",
        "\n",
        "1.   Implementation Auth (Username and Password) use the Advance of API collection for checking this demo.\n",
        "2.   Implementation of Proper Error Handling\n",
        "\n"
      ]
    },
    {
      "cell_type": "code",
      "metadata": {
        "id": "uSE7dFpGrYZy",
        "colab": {
          "base_uri": "https://localhost:8080/"
        },
        "outputId": "a01f75cc-9b6f-4e38-f4a9-3c5376f6e4e9"
      },
      "source": [
        "!pip install flask-httpauth"
      ],
      "execution_count": 20,
      "outputs": [
        {
          "output_type": "stream",
          "text": [
            "Collecting flask-httpauth\n",
            "  Downloading https://files.pythonhosted.org/packages/b7/10/387aba19908b3fedc45741aa7e8122d3328987efacde7acc4dcfb05075f2/Flask_HTTPAuth-4.2.0-py2.py3-none-any.whl\n",
            "Requirement already satisfied: Flask in /usr/local/lib/python3.6/dist-packages (from flask-httpauth) (1.1.2)\n",
            "Requirement already satisfied: click>=5.1 in /usr/local/lib/python3.6/dist-packages (from Flask->flask-httpauth) (7.1.2)\n",
            "Requirement already satisfied: itsdangerous>=0.24 in /usr/local/lib/python3.6/dist-packages (from Flask->flask-httpauth) (1.1.0)\n",
            "Requirement already satisfied: Jinja2>=2.10.1 in /usr/local/lib/python3.6/dist-packages (from Flask->flask-httpauth) (2.11.3)\n",
            "Requirement already satisfied: Werkzeug>=0.15 in /usr/local/lib/python3.6/dist-packages (from Flask->flask-httpauth) (1.0.1)\n",
            "Requirement already satisfied: MarkupSafe>=0.23 in /usr/local/lib/python3.6/dist-packages (from Jinja2>=2.10.1->Flask->flask-httpauth) (1.1.1)\n",
            "Installing collected packages: flask-httpauth\n",
            "Successfully installed flask-httpauth-4.2.0\n"
          ],
          "name": "stdout"
        }
      ]
    },
    {
      "cell_type": "code",
      "metadata": {
        "colab": {
          "base_uri": "https://localhost:8080/"
        },
        "id": "EnTLsiypB4gZ",
        "outputId": "96fcd4c6-73c2-4372-cecd-15a8ac182a59"
      },
      "source": [
        "from flask import Flask, jsonify\n",
        "from flask_restful import Api, Resource, reqparse\n",
        "from flask_ngrok import run_with_ngrok\n",
        "from flask import make_response\n",
        "import random\n",
        "\n",
        "## Add Authentication \n",
        "from flask_httpauth import HTTPBasicAuth\n",
        "\n",
        "## Auth Code Start\n",
        "auth = HTTPBasicAuth()\n",
        "\n",
        "# Add Users\n",
        "users = {\n",
        "    \"ali\": \"iali.dev\",\n",
        "    \"public\": \"public\"\n",
        "}\n",
        "\n",
        "# Get Password mechanism \n",
        "@auth.get_password\n",
        "def get_pass(username):\n",
        "    if username in users:\n",
        "        return users.get(username)\n",
        "    return None\n",
        "\n",
        "## Auth Code End\n",
        "\n",
        "app = Flask(__name__)\n",
        "api = Api(app)\n",
        "\n",
        "dev_jokes = [\n",
        "    {\n",
        "        \"id\": 0,\n",
        "        \"author\": \"NA\",\n",
        "        \"joke\": \"Q: How did the Coder CEO build his company headquarters? A: By calling the Constructor();\", \n",
        "        \"source\": \"https://github.com/shrutikapoor08/devjoke/blob/master/README.md\"\n",
        "    },\n",
        "    {\n",
        "        \"id\": 1,\n",
        "        \"author\": \"NA\",\n",
        "        \"joke\": \"Q: What is Hardware? A: The part of the computer which you can kick.\",\n",
        "        \"source\": \"https://github.com/shrutikapoor08/devjoke/blob/master/README.md\"\n",
        "    },\n",
        "    {\n",
        "        \"id\": 2,\n",
        "        \"author\": \"NA\",\n",
        "        \"joke\": \"Q: Who is a programmer? A: A programmer is a machine who turns coffee into code.\",\n",
        "        \"source\": \"https://github.com/shrutikapoor08/devjoke/blob/master/README.md\"\n",
        "    },\n",
        "    {\n",
        "        \"id\": 3,\n",
        "        \"author\": \"NA\",\n",
        "        \"joke\": \"First rule of programming : If it works DON'T touch it.\",\n",
        "        \"source\": \"https://github.com/shrutikapoor08/devjoke/blob/master/README.md\"\n",
        "    }\n",
        "]\n",
        "\n",
        "class joke(Resource):\n",
        "    def get(self, id=0):\n",
        "        if not id:\n",
        "            return random.choice(dev_jokes), 200\n",
        "        for joke in dev_jokes:\n",
        "            if(joke[\"id\"] == id):\n",
        "                return joke, 200\n",
        "        return \"Joke not found\", 404\n",
        "      \n",
        "class adjoke(Resource):\n",
        "    @auth.login_required\n",
        "    def post(self):\n",
        "      parser = reqparse.RequestParser()\n",
        "      parser.add_argument(\"id\",type=int,required=True)\n",
        "      parser.add_argument(\"author\",required=True)\n",
        "      parser.add_argument(\"joke\",required=True)\n",
        "      parser.add_argument(\"source\")\n",
        "      params = parser.parse_args()\n",
        "      id = params[\"id\"]\n",
        "      for joke in dev_jokes:\n",
        "          if(id == joke[\"id\"]): \n",
        "              return make_response(jsonify({'error': 'Joke with this id already exists add new id'}), 400)\n",
        "      joke = {\n",
        "          \"id\": int(id),\n",
        "          \"author\": params[\"author\"],\n",
        "          \"joke\": params[\"joke\"],\n",
        "          \"source\": params[\"source\"]\n",
        "      }\n",
        "      dev_jokes.append(joke)\n",
        "      return joke, 201\n",
        "\n",
        "    def put(self):\n",
        "      parser = reqparse.RequestParser()\n",
        "      parser.add_argument(\"id\",type=int,required=True)\n",
        "      parser.add_argument(\"author\",required=True)\n",
        "      parser.add_argument(\"joke\",required=True)\n",
        "      parser.add_argument(\"source\")      \n",
        "      params = parser.parse_args()\n",
        "      id = int(params[\"id\"])\n",
        "      for obj in dev_jokes:\n",
        "          if(id == obj[\"id\"]):\n",
        "              obj[\"author\"] = params[\"author\"]\n",
        "              obj[\"joke\"] = params[\"joke\"]\n",
        "              obj[\"source\"] = params[\"source\"]\n",
        "              return obj, 204\n",
        "      else:\n",
        "            return make_response(jsonify({'error': 'ID is not present in database'}), 404)\n",
        "\n",
        "    def delete(self, id='c'):\n",
        "        if id is 'c':\n",
        "          return make_response(jsonify({'error': 'ID is missing'}), 400)\n",
        "        global dev_jokes\n",
        "        dev_jokes = [joke for joke in dev_jokes if joke[\"id\"] != id]\n",
        "        return f\"Joke with id {id} is deleted.\", 200\n",
        "\n",
        "\n",
        "class home(Resource):\n",
        "  def get(self):\n",
        "    return \"Hey there! This is a simple demo for making an API server made by Ali Mustufa Shaikh;\"\n",
        "\n",
        "api.add_resource(joke, \"/joke\", \"/joke/\", \"/joke/<int:id>\")\n",
        "api.add_resource(home,\"/\")\n",
        "api.add_resource(adjoke,\"/adjoke/<int:id>\",\"/adjoke/\",\"/adjoke\")\n",
        "\n",
        "# For Error Handling Best Practises\n",
        "\n",
        "@app.errorhandler(404)\n",
        "def not_found(error):\n",
        "    return make_response(jsonify({'error': 'Not found'}), 404)\n",
        "\n",
        "@auth.error_handler\n",
        "def unauthorized():\n",
        "    return make_response(jsonify({'error': 'Unauthorized Access'}), 401)\n",
        "\n",
        "\n",
        "if __name__ == '__main__':\n",
        "    run_with_ngrok(app)\n",
        "    app.run()"
      ],
      "execution_count": 31,
      "outputs": [
        {
          "output_type": "stream",
          "text": [
            " * Serving Flask app \"__main__\" (lazy loading)\n",
            " * Environment: production\n",
            "\u001b[31m   WARNING: This is a development server. Do not use it in a production deployment.\u001b[0m\n",
            "\u001b[2m   Use a production WSGI server instead.\u001b[0m\n",
            " * Debug mode: off\n"
          ],
          "name": "stdout"
        },
        {
          "output_type": "stream",
          "text": [
            " * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)\n"
          ],
          "name": "stderr"
        },
        {
          "output_type": "stream",
          "text": [
            " * Running on http://49b5c2b57127.ngrok.io\n",
            " * Traffic stats available on http://127.0.0.1:4040\n"
          ],
          "name": "stdout"
        }
      ]
    },
    {
      "cell_type": "code",
      "metadata": {
        "id": "dwSWx-3TGZ6c"
      },
      "source": [
        ""
      ],
      "execution_count": null,
      "outputs": []
    }
  ]
}