Giter VIP home page Giter VIP logo

catdex-api's Introduction

Catdex API

This is an API built using actix_web, postgres and Rust.

Requirements

  • [] Postgres database
  • [] Rust Runtime

Usage

    cd catdex-api

    # install packages
    cargo build

    # add database to terminal env
    export DATABASE_URL=postgres://{{database-user}}:{{database-password}}@localhost/{{database-name}}

SSL Certificates

SSL certificates required because the server is served on HTTPS

    # install openssl
    sudo apt install openssl

    # Generate certificate
    openssl req -x509 -newkey rsa:4096 keyout key.pem out cert.pem days 365 sha256 subj "/CN=localhost"

    # geneate password less key
    openssl rsa -in key.pem -out key-no-password.pem

    #install required headers for OS
    sudo apt install libssl-dev

Start Application

    # start server
    cargo run

API

    # Get Cats
    curl https://localhost:5050/api/cats

    # Get Single Cat
    curl https://localhost:8080/api/cats/1

    # Create cat. NOTE image should be a path to an existing image file
    curl -F "name=Persian" -F "[email protected]" https://localhost:5050/api/cats

catdex-api's People

Contributors

abdraqeeb 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.