Skip to content

Latest commit

 

History

History
96 lines (67 loc) · 2.3 KB

credit-card-api.adoc

File metadata and controls

96 lines (67 loc) · 2.3 KB

Credit Card API - Access Guide

Table of Contents

Overview

Note
 Credit Card Api is a RestFul application built with Spring Boot and Embedded MongoDB It’s based on Level 3 of the famous Richardson Maturity Model. This is one of the most discussed subjects about API design. This source code is hosted in https://github.com/jonyfs/credit-card-api.

Endpoints

Environment Url

dev

{dev-endpoint-url}

test

{test-endpoint-url}

production

{endpoint-url}

HTTP verbs

Note
 RESTful notes tries to adhere as closely as possible to standard HTTP and REST conventions in its use of HTTP verbs.
Verb Usage

GET

Used to retrieve a resource

POST

Used to create a new resource

HTTP status codes

Note
 RESTful notes tries to adhere as closely as possible to standard HTTP and REST conventions in its use of HTTP status codes.
Status code Usage

200 OK

The request completed successfully

201 Created

A new resource has been created successfully. The resource’s URI is available from the response’s Location header

204 No Content

An update to an existing resource has been applied successfully

400 Bad Request

The request was malformed. The response body will include an error providing further information

422 Unprocessable Entity

The request was well-formed but was unable to be followed due to semantic errors.

404 Not Found

The requested resource did not exist

Hypermedia

Note
 RESTful Notes uses hypermedia and resources include links to other resources in their responses. Responses are in Hypertext Application Language (HAL) format. Links can be found benath the _links key. Users of the API should not created URIs themselves, instead they should use the above-described links to navigate from resource to resource.