Giter VIP home page Giter VIP logo

animeapi's Introduction

アニメアプリケーションプログラミングインターフェース

AniAPI for short

Target Framework Badge Build Badge CodeFactor Badge

What is it? 🤔

AniAPI, as the name suggest, is a RESTful Aplication Programming Interface

What does it do? 🕸️

As of now, it allows the user to locally manage their anime watchlist via MongoDB and ASP.NET Core, more specifically HTTP requests

Database schema can be found on /swagger or in file Anime.cs
class Anime
{
  [BsonElement("_id")]
  string Id

  [BsonElement("name")]
  string Name

  [BsonElement("finished")]
  bool DoneWatching

  [BsonElement("finished_airing")]
  bool IsAiringFinished

  [BsonElement("current_episode")]
  int CurrentEpisode

  [BsonElement("total_episodes")]
  int TotalEpisodes
}
Usage examples 🧪

Get all animes

GET /anime

Delete a specific one

DELETE /anime?id=1243

Partially update an anime

PATCH /anime?id=1234&field=name&value=Bleach
⚠️ The id's presented in the examples aren't valid and won't be accepted by the app ⚠️
Get it up and running ⚙️
  • Make sure you have MongoDB installed and there's an instance running

    • The app connects to a passwordless database so make sure of it
  • .Net 5! It's required, click on the Target badge

  • Configure your environment variables or set the appropiate flags at the last point

    • Database and Collection. They're case sensitive!
  • Clone the repo

git clone https://github.com/StanlsSlav/AniAPI.git \
cd AniAPI
dotnet run -p ./AnimeAPI -c Release

# Or with flags
dotnet run -p ./AnimeAPI -c Release -- -d <DB> -c <col>

P.S. Highly encouraging everybody to create their own validation rules and make daily exports of the data!


Seems fun? Contribute and help on making it awesome grander

  1. Fork the project
  2. Modify it
  3. Open a pull request

animeapi's People

Contributors

stanlsslav avatar dependabot[bot] avatar

Watchers

 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.