Code Monkey home page Code Monkey logo

gunplaapi's Introduction

gunplaAPI

This is a REST API containing information on HG Gunpla model kits.

Information

This API is written as a REST API, with appropriate routes for creating, editing, updating, and deleting entries. All requests should be made under the /gunpla URL directory.

Request types

GET

For all entries, use a GET request with the /gunpla endpoint.
For a entry with a specific numerical id, use the /gunpla/[id] endpoint with a valid entry id.
Searching is possible by kit name and release time using query string parameters.
Kit name searching is done with /gunpla/?name=[name].
Release date searching is done with /gunpla/?date=[date].

POST

To add a new entry, use a POST request with the /gunpla endpoint.
All parameters must be specified in the body for a new gunpla entry under the following names:

  • name, series, height, manufacturer, price, and release time.

PUT

To update an existing entry, use a PUT request, specifying a valid entry id with the /gunpla/[id] endpoint.
All parameters must be specified in the body for a new gunpla entry under the following names:

  • name, series, height, manufacturer, price, and release time.

DELETE

To delete a given entry, use a DELETE request, specifying a valid entry id with the /gunpla/[id] endpoint.

Sample Response

All responses are returned as a JSON object, with the number of returned entries included for search-based GET requests.
An example of a single entry:

{"data":  
{"name":"RX-0 Unicorn Gundam",  
"series":"Mobile Suit Gundam Unicorn",  
"height":19.7,  
"manufacturer":"Anaheim Electronics",  
"price":"¥1,500",  
"release":"2009 November"}}

An example of a request returning multiple entries:

{"results":2,  
"data":[{"name":"RGM-96X Jesta",  
"series":"Mobile Suit Gundam Unicorn",  
"height":19.3,  
"manufacturer":"Anaheim Electronics",  
"price":"¥1,600",  
"release":"2011 September"},  
{"name":"RGM-96X Jesta Cannon",  
"series":"Mobile Suit Gundam Unicorn",  
"height":19.3,  
"manufacturer":"Anaheim Electronics",  
"price":"¥2,000",  
"release":"2013 February"}]}

gunplaapi's People

Contributors

brianlin345 avatar

Stargazers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.