Please enable JavaScript.

Coggle requires JavaScript to display documents.

REST API Design Rules (Terminologies (JSON (standardized text format,…

- - - - standardization of this most recent version of the communication protocol
  - - - specific Web-based concept
  - - - web server-owned resource
  - - - conforms to the Web’s architectural style
  - - - holding on to any client-specific state information
- - - - declares cacheability of each response
    - - organization's web server network
      - within specialized Content Delivery Networks (CDNs)
      - inside client itself
  - - - proxy
      - gateway
      - used for
        
        security
        
        response caching
        
        load balancing
  - - - results to
        
        client must include all contextual information
  - - - Identification of resources
        
        addressed by unique identifier (like URI)
        
        each web concept is a resource
      - Manipulation of resources through representations
        
        way to interact with the resource, but not the resource itself
        
        allows resource to be represented in different ways and format
        
        can be represented as HTML, JSON etc.
      - Self-descriptive messages
        
        desired state
        
        can be represented with client's request message
        
        current state
        
        can be represented within response message that comes back from the server
      - Hypermedia as the engine of application state (HATEOAS)
        
        state representation includes links to related resources
        
        links are threads that weave the Web
        
        allows users to traverse information and applications
        
        presence and absence of link on a page is an important part of resource current state
  - - - scripts
      - plug-ins
    - - between
        
        web servers
        
        clients
        
        must be able to understand and execute the code
    - - Java applets
      - JavaScript
      - Flash
- - - - uses a set of basic shapes to represent each of the resource
- - - - used in the path portion
      - example
        
        http://api.canvas.restapi.org/shapes/polygons/quadrilaterals/squares
      - indicate a hierarchical
        relationship
    - - should not be included in URIs
      - no semantic value
      - may cause confusion
      - REST API
        
        should not expect a trailing slash
        
        should not include them
      - example
        
        http://api.canvas.restapi.org/shapes/
    - - used to improve the readability of URIs
      - example
        
        http://api.example.restapi.org/blogs/mark-masse/entries/this-is-my-first-post
    - - should not be used in URIs
      - provide a visual cue that they are clickable
      - partially obscured
      - can be completely hidden by this underlining
      - use hyphens (-) instead of underscores
    - - preferred in URI paths
      - capital letters can sometimes cause problems
      - example
        
        http://api.example.restapi.org/my-folder/my-doc
    - - should not be included in URIs
      - the period (.) character
        
        should rely on the media type
      - example
        
        valid
        
        http://api.college.restapi.org/students/3248234/transcripts/2005/fall
        
        avoid
        
        http://api.college.restapi.org/students/3248234/transcripts/2005/fall.json
    - - URI = scheme "://" authority "/" path [ "?" query ] [ "#" fragment ]
  - - - consistent names should be used for APIs
      - full domain name of an API should add a sub- domain named api
      - example
        
        http://api.soccer.restapi.org
      - client developer portal
        
        secure API access keys
        
        should have a subdomain labeled developer
        
        example
        
        http://developer.soccer.restapi.org
  - - - should be used for document names
      - example
        
        http://api.soccer.restapi.org/leagues/seattle/teams/trebuchet/players/claudio
    - - should be used for collection names
        
        example
        
        http://api.soccer.restapi.org/leagues/seattle/teams/trebuchet/players
      - should be used for store names
        
        example
        
        http://api.music.restapi.org/artists/mikemassedotcom/playlists
    - - used for controller names
      - example
        
        http://api.college.restapi.org/students/morgan/register
        
        http://api.example.restapi.org/lists/4324/dedupe
    - - may be substituted with identity-based
        values
      - path segments are static
        
        have fixed names that may be chosen by the REST API’s designer
    - - should not be used in URIs
      - URIs should be used to uniquely identify resources
      - example
        
        avoid
        
        DELETE /deleteUser/1234
        
        valid
        
        DELETE /users/1234
  - - - URI = scheme "://" authority "/" path [ "?" query ] [ "#" fragment ]
      - example
        
        http://api.college.restapi.org/students/morgan/send-sms
        
        http://api.college.restapi.org/students/morgan/send-sms?text=hello
    - - may be used to filter collections or stores
        
        example
        
        GET /users?role=admin
      - used to paginate collection
        or store results
        
        example
        
        GET /users?pageSize=25&pageStartIndex=50
- - - - facilitates interactions between computer programs
      - allows to exchange information