Micro Services Classroom Series – 11/Nov/2021

Design your API First

  • Designing the API First

    • Can’t fix an API after publishing
    • Helps understanding the requirements
    • Well Designed API can mature
  • REST APIs Have Several Parts

    • Request Preview Preview
  • What are URIs (Uniform Resource Identifier)?

    • URIs are paths to Resources api.yourserver.com/users
    • Query Strings for non-data elements
      • E.g format, sorting, searching etc
  • API Design:

    • Nouns are Good, Verbs are Bad
    • Bad URI’s
    /getCustomers
    /getCustomersByName
    /getCustomersByMail
    /getNewCustomer
    /saveCustomer
    /updateCustomer
    /deleteCustomer
    
    • Good URI’s
    /customers
    /invoices
    /products
    /employees
    
  • What are Resources? Preview Preview Preview

  • Identifiers in URI

    • Use unique Identifier
    • Does not have to be primary keys
    /users
    /users/shaikkhajaibrahim
    /users/1
    /products
    /products/e-101
    

Developer Setup

  • Pre-requisites
    • Python 3.9.x (latest version of python to be installed)
    • Pycharm Community Edition Installed.
    • pip should be installed
  • Lets create our first project
  • Lets install flask from pip in PyCharm Terminal Preview Preview Preview
  • Refer Here for the repository and try to fork the repository
  • Refer Here for the changes done to run a simple application which can respond to http request on (/)

Leave a Comment

This site uses Akismet to reduce spam. Learn how your comment data is processed.

About learningthoughtsadmin