Please enable JavaScript.

Coggle requires JavaScript to display documents.

REST API (Design (Resources/Endpoints (Base API URL (Subdomain (Separate…

- - - - www domain :red_cross:
      - Simple
      - Subdomain
        
        Separate Domain
    - - Names
        
        Plural
    - - NOT CRUD API
      - Verb
    - - Resources
        
        In
        
        Resources
      - Max 3 Levels
  - - - POST
        
        Create
      - PUT
        
        Update
      - GET
        
        Read
      - DELETE
        
        Delete
      - PATCH
        
        Partial
        
        Update
    - - 1XX
        
        Informational
      - 2XX
        
        Success
      - 3XX
        
        Redirection
      - 4XX
        
        Client Error
      - 5XX
        
        Server Error
    - - Query
        
        Parameters
      - HTTP
        
        Header
        
        Accepts
      - Resource
        
        Format
        
        Suffix
  - - - Specific
        
        Numeric Code
      - HTTP Status
        
        8 code Max
  - - - New
        
        Operations
        
        Resources
      - Optional
        
        Parameters
        
        Properties
    - - HTTP
        
        Verb
        
        Method
      - Delete
        
        Operation
      - Backward
        
        Compatibility
        
        If Possible
    - - Specify
        
        Version
        
        HTTP Header
        
        Query
        
        Parameter
        
        URL
      - Format
        
        Information
        
        Date
        
        (v)major.minor
        
        version = "12"
  - - - All Touchpoints
    - - Speed of Change
      - Time Sensitivity
      - Security
    - - HTTP Cache Control Directives
        
        RF2616
      - Private Vs Public
        
        Public by default
      - no-store
      - no-cache
      - ETag Header
        
        Hash
        
        Check Change
        
        304 Code
        
        Not modified
      - max-age
        
        seconds
  - - - /people:(ID,first-name,last-name)
      - /friends?fields = ID,name,picture
  - - - Of Rows
        
        Needed
    - - Cursor-based
        
        Efficient
      - Offset-based
        
        Popular
        
        Query Parameters
        
        Offset
        
        Limit
      - HTTP Header
        
        RFC5988
        
        Link Header
- - - - Build
        
        Publish
        
        Deprecated
        
        Retired
  - - - API Documentation
        
        Self Serve Provisioning
        
        Support
        
        API Developer Portal
    - - Design & Dev
        
        Specifications
        
        Based Tooling
      - Policy
        
        Based
        
        Implementation
  - - - API Key
        
        Revocation
        
        Statistics
    - - Monitoring
  - - - Quota
        
        Rate Limiting
        
        Spike Arrest
  - - - Catch Errors
        
        Understand Attacks
  - - - Proxy on servers
        
        After
        
        Security Gateway
    - - Proxy at the edge
- - - - Postman
        
        SOAPUI
    - - Online
        
        mlab.com
        
        cloud.mongoDB.com
    - - editor.swagger.io
    - - Mulesoft
        
        APIGee
        
        IBM API Connect
        
        Mashery
        
        Akana
        
        3Scale
  - - - Node.js
        
        Python
        
        Java
        
        Go
        
        PHP
  - - - User Interface
    - - Heavy Traffic
        
        CPU & Memory Intensive
        
        Slow Browser
  - - - Object
        
        Thing
        
        Entity
      - Representational
        
        State
    - - Style
    - - But
        
        Not Only
  - - - Key/Secret
        
        OAuth
    - - Portal
    - - email
        
        Tickets
      - Developer Portal
    - - Uptime
        
        Througput
        
        Support
- - - - HTTP Header with Encoded Cred.
        
        To Server
        
        user:password
    - - ONLY
    - - MIT Attack
      - No Session Support
      - Hardcoding Credentials
        
        Mobile Apps
    - - Authentication MW
        
        For Nodejs
        
        Multiple forms
  - - - No token / Credential
        
        In Mobile App
    - - Encoded String
      - Transmission
        
        HTTP Header
        
        Query Parameter
        
        Request Body
      - Validity
        
        Revokation
      - Server
        
        Storage
    - - JSON Web Token
        
        Header
        
        Type "JWT"
        
        Hashing Algo
        
        Payload
        
        Registered Claim
        
        Issuer
        
        Expiration
        
        Not before timestamp
        
        Public Claim
        
        Name
        
        Email
        
        Phone Number
        
        Private Claim
        
        Specific
        
        Signature
        
        Hash
        
        Header
        
        Payload
        
        With Secret
  - - - Token-based
        
        5 Methods
      - End User
        
        In Control
      - API Key & Secret
    - - Authorization Request
        
        Authorization Grant
        
        Access Token
    - - No AZ Flow
      - Secret
        
        Not Protected
      - Access
        
        To user data
    - - Public Data
  - - - Long random
        
        String
      - Identity
        
        Proof
    - - Client ID
    - - HTTP Header
      - Query Parameters
      - Request Body
    - - APIGEE
        
        IBM
        
        Mashery
        
        Mulesoft
  - - - SQL Injection
      - Fuzzing
        
        Random Input
        
        Understand
      - Cross Site Forgery
        
        Scripts
        
        User Browser
      - Session Hijack
- - - - Then
        
        Code
  - - - Documentation
    - - Generation
    - - Code
        
        Generation
  - - - JSON
        
        YAML
    - - Editor
        
        editor.swagger.io
  - - - Definitions
        
        Request Response
        
        Schema
        
        Example
      - Parameters
        
        Name
        
        Description
        
        In
        
        Required
      - SecurityDefinitions
        
        Type
        
        Basic
        
        APIKey
        
        OAuth2
        
        Name
        
        Description
        
        In
    - - Multiple
        
        Definitions
        
        Possible
      - Operations
        
        Summary
        
        Description
        
        Tags
        
        External Documentation
        
        Consumes
        
        Produces
        
        Parameters
        
        Responses
        
        Security
    - - Metadata
        
        Info
        
        Version
        
        Title
        
        Description
        
        Contact
        
        Name
        
        URL
        
        email
        
        Licence
        
        Name
        
        URL
      - Root Document
        
        Host
        
        Base Path (v1)
        
        Schemes[String]
        
        HTTP/HTTPS
        
        Consumes[String]
        
        application/json
        
        application/xml
        
        plain/text
        
        Produces[String]
        
        JSON/XML/TXT
      - External Documentation
        
        Description+URL
      - Tags
        
        Name+Description
- - - - Separation of Concern
      - RPC Over HTTP
    - - 1 Technical
        
        Interface
      - Ressource
        
        Identity
        
        URI/URL
      - Representation
      - Self-Descriptive
        
        Messages
        
        Metadata
        
        Content Type
        
        HTTP
        
        Status
        
        Code
        
        Host
        
        Accept
      - Hypermedia
        
        Data + Action
    - - Each
        
        Request
        
        Independent
      - All
        
        Infos
        
        In
        
        Request
        
        Session :red_cross:
      - No
        
        State
        
        Management
    - - Types
        
        Shared
        
        Gateway
        
        Server
        
        Local
      - Controlled
        
        By HTPP Header
        
        Cache-Control
        
        Expires
        
        Last-Modified
        
        ETag
    - - Complexity
        
        Hidden
      - Load Balancer
        
        Gateway
    - - Optional
      - Functionality
        
        Extension
        
        With
        
        Sending
        
        Code
        
        B
        
        1 more item...
    - - Richardson
        
        Level 0
        
        XML
        
        Level 1
        
        Resources
        
        Instead of
        
        End Points
        
        Level 2
        
        Verbs
        
        Level 3
        
        Hypermedia controls
        
        Media Links
        
        For
        
        Future
        
        1 more item...