Data

Data

1. data interface

   • rest principles
     • Client-Server decoupling
       • In a REST API design, client and server programs must be independent. The client software should only know the URI of the requested resource; it should have no additional interaction with the server application.
     • Uniform Interface
       • All API queries for the same resource should look the same regardless of where they come from. The REST API should ensure that similar data, such as a user's name or email address, is assigned to just one uniform resource identifier (URI).
     • Statelessness
       • REST APIs are stateless, meaning each request must contain all the information needed to process it.
     • Layered System architecture
       • REST API requests and responses are routed through many tiers. REST APIs must be designed so neither the client nor the server can tell whether they communicate with the final application or an intermediary.
     • Cacheable
       • Wherever feasible, resources should be cacheable on the client or server side. Server responses must additionally indicate if caching is authorized for the offered assistance. The objective is to boost client-side speed while enhancing server-side scalability.
     • Code on demand
       • allowing servers to extend the functionality of a client by transferring executable code (though also reducing visibility, making this an optional guideline).
   • SOAP
     • Largely Based on REST principles
     • once a request is received, return SOAP messages must be returned as XML documents—a markup language that is both human- and machine-readable.
     • A completed request to a SOAP API is not cacheable by a browser, so it cannot be accessed later without resending to the API.
     • Has various web service specifications

2. Data exchange methods

   • JSON
     • Data Structures
       • Object and Arrays
     • Data Specifications
       • Object
       • Array
       • Number
       • String
       • Boolean
       • Null
   • XML
     • Data Structures
       • Elements and Attributes
     • Data Specification
       • Plain Text
   • SQL
     • Data Structures
       • Objects and Arrays
     • Data Specifications
       • BigInt, Integer, SmallInt, TinyInt
       • Numeric, Decimal
       • Float, Real, Double
       • Data, Time, Timestamp
       • Varchar, LongVarChar, NChar, LongNVarChar
       • VarBinary, Binary, LongBinary, Bit

3. Data Format

   • JSON
     • syntax
       • Data is in name/value pairs
       • Data is separated by commas
       • Curly braces hold objects
       • Square brackets hold arrays
   • XML
     • syntax
       • All XML elements must have a closing tag.
       • XML tags are case sensitive.
       • All XML elements must be properly nested.
       • All XML documents must have a root element.
       • Attribute values must always be quoted.

4. MARVEL API

   • /characters
     • {characterId}
       • comics
       • events
       • series
       • stories
   • /comics
     • {comicId}
       • characters
       • creators
       • events
       • stories
   • /creators
     • {creatorId}
       • comics
       • events
       • series
       • stories
   • /events
     • {eventId}
       • characters
       • comics
       • creators
       • series
       • stories
   • /series
     • {seriesId}
       • characters
       • comics
       • creators
       • events
       • stories
   • /stories
     • {storiesId}
       • characters
       • comics
       • creators
       • events
       • series