Skip to content

Latest commit

 

History

History
110 lines (78 loc) · 4.71 KB

README.md

File metadata and controls

110 lines (78 loc) · 4.71 KB
Raw

Patlabor API

API with information of Mobile Police Patlabor 🤖 Patlabor banner

GitHub release (latest by date including pre-releases)

About Patlabor API

This project aims to provide information and images of the anime Mobile Police Patlabor.

What is an API?

An API (Application Programming Interface) is a contract that allow developers to interact with an application through a set of interfaces. In this case, the application is a database with patlabor-anime information, and the interfaces are URL links. A RESTful API is an API that conforms to a set of loose conventions based on HTTP verbs, errors, and hyperlinks.

Try the project

Get Character 1 information:

https://patlabor-api.herokuapp.com/api/v1/characters/1

Result:

{
    "id": 1,
    "name": "Noa Izumi",
    "age": null,
    "birthplace": "Tomakomai, Hokkaido, Japan",
    "nationality": "Japanese",
    "gender": "female",
    "occupation": "Labors pilot",
    "rank": "officer",
    "affiliation": "Section 2 Division 2 Team 1",
    "image": "https://patlabor-api.herokuapp.com/images/characters/1.jpg",
    "description": "Noa is somewhat impulsive, albeit not nearly as much as Ohta... "
}

Routes

END POINT HTTP METHOD GET
/characters List all Characters
/characters/{id} Show Character
/labors List all Labors
/labors/{id} Show Labor

Usage

[to edit...]

Contact me

Let me know about the cool projects you develop with Patlabor API 😄

  • Follow me on Twitter, I usually share development stuff Twitter Follow
  • Did you use or see the project? Share with me your feedback! Twitter

Contributing

Thank you for considering contributing to Patlabor API

  • You can contribute by sending information about characters or labors that have not yet been added.
  • You can also contribute by suggesting improvements to the project, code, endpoints, etc.
  • Reporting bugs

In any case, feel free to create a new issue with detailed explanation please!

Software requirements

  • GIT
  • PHP
  • Composer

Installation

  • git clone https://github.com/lmendev/patlabor-api
  • cd patlabor-api
  • composer install
  • Generate your application encryption key using php artisan key:generate
  • Copy and rename .env.example file to .env
  • Create a database named patlabor_api and inform to .env file
  • php artisan migrate --seed to create and populate tables
  • php artisan serve to start the app on http://localhost:8000/
  • Check everything is OK accessing on http://localhost:8000/api/v1/characters/1

Sources

Information gathered from various resources:

License

The story of Patlabor, images and designs are copyrighted material. This is a fan made project and is not intended to infringe on any copyrighted material. Images and synopses of Patlabor material is intended to be used for information, review and research purposes only for other fans and is in no way used for profit.

All images are copyright of their respective owners. ©1988 - 1994, 2002, 2014 - 2016 Headgear/Emotion/Bandai Visual/TFC/Shogakukan/NTV/Production I.G./Akemi Takada/Masami Yuuki/The Next Generation - Patlabor - Production Committee/Khara. All other logos/trademarks are copyright of their respective owners/companies. Images on this project are used for review and illustration purposes only.

Patlabor API is open-sourced software licensed under the MIT license.