Giter Club home page Giter Club logo

prinboard-api's Introduction

Prinboard API

A headless API to get, post, update, and delete links.

Root url

https://prinboard-api.herokuapp.com/

Schema

Link

	{
		author: { type: String, required: true }
		created_at: { type: Date, default: Date.now }
		name: { type: String, required: true }
		tags: { type: [String], default: [] }
		updated_at: { type: [Date], default: [] }
		url: { type: String, required: true }
	}

Endpoints

Get

  • */api/fetch

    • If no query param is provided, returns all links paginated and sorted by date.

    • If a query param is provided, returns paginated results text matched for name, author, and tag sorted by date.

    • Query params:

      • page - Results page number
      • query - Search term
    • Example:

        api/fetch?query=principal&page=2
      
  • /api/delete/:_id

    • Deletes a link entry.

    • Returns status 200 upon successful deletion.

    • Example:

        api/delete/1234
      
  • /api/fetch/tags

    • Returns an unsorted array of all unique tags.

Post

  • /api/update/:id
    • Updates a link entry.
    • Pushes new date into updated_at array.
    • Post body:
      • any valid field with new value

      • Example:

          { name: "new name" }
        
  • /api/create
    • Creates a new link entry using Link schema.

    • Example:

        {
        	author: "Dave",
        	name: "Google",
        	url: "google.com",
        	tags: [ "Search engine" ]
        }
      

prinboard-api's People

Contributors

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