API TERMINOLOGY Part 4

-

Comments

Post a Comment

Popular posts from this blog

Python Docstrings

-
Python Docstrings Python documentation strings (or docstrings) provide a convenient way of associating documentation with Python modules, functions, classes, and methods. It’s specified in source code that is used, like a comment, to document a specific segment of code. Unlike conventional source code comments, the docstring should describe what the function does, not how. How docstring look like? The doc string line should begin with a capital letter and end with a period. The first line should be a short description. If there are more lines in the documentation string, the second line should be blank, visually separating the summary from the rest of the description. The following lines should be one or more paragraphs describing the object’s calling conventions, its side effects, etc. Doc String can be one liner or multiliner based on requirements with proper indentation . Declaring Docstrings: The docstrings are declared using ”’triple single quotes”’ or “””triple double quotes””” j...
Read more

HTTP METHODS

-
  HTTP METHODS GET Method: The HTTP GET method is used to read/ retrieve a representation of a resource. In the happy path ( non-error), GET returns a representation in XML or JSON and an HTTP response code of 200 (OK). In an error case, it most often returns a 404 (NOT FOUND) or 400 (BAD REQUEST). POST Method: The POST verb is most-often utilized to create new resources. In other words, when creating a new resource, POST to the parent and the service takes care of associating the new resource with the parent, assigning an ID (new resource URI), etc. On successful creation, return HTTP status 201, returning a Location header with a link to the newly-created resource with the 201 HTTP status.In an error case 404 (Not Found), 409 (Conflict) if resource already exists. PUT Method: PUT is most-often utilized for update capabilities, PUT-ing to a known resource URI with the request body containing the newly-updated representation of the original resource. On successful update, return 20...
Read more