Skip to content

Latest commit

 

History

History
128 lines (109 loc) · 2.79 KB

api.md

File metadata and controls

128 lines (109 loc) · 2.79 KB

FORMAT: 1A

VUTTR

VUTTR is an API that allows registering and visualization of data about useful tools for different tasks.

Group tools

Resources related to tool data.

Tool [/tools?tag={tag}&tagSearch=1]

A tool object has the following attributes:

  • title
  • link - Link to download or use the specified tool
  • description - More details about the tool
  • Tags - A collection of tags used for tool searching

View the available tools [GET]

Retrieves all the tools that have a specified tag, or all the registered tools if the tag is not provided.

  • Parameters

    • tag: (optional, string) - term to search for tools
    • tagSearch: (optional, integer) - search for the term only in tags list if value is 1

  • Response 200 (application/json)

[  
  {  
    "tags": [  
      "web",  
      "framework",  
      "node",  
      "http2",  
      "https",  
      "localhost"  
    ],  
    "_id": "5dcca3172aca6604c4984090",  
    "title": "fastify",  
    "link": "https://www.fastify.io/",  
    "description": "Extremely fast and simple, low-overhead web framework for NodeJS. Supports HTTP2."  
  },  
  {  
    "tags": [  
      "web",  
      "framework",  
      "node",  
      "http2",  
      "https",  
      "localhost"  
    ],  
    "_id": "5dceaf507c1e5d06d45e42b2",  
    "title": "react",  
    "link": "https://reactjs.org/",  
    "description": "Extremely fast and simple, low-overhead web framework for NodeJS. Supports HTTP2.",  
    "__v": 0  
  }  
]

Create a new tool [POST]

You can create a new tool using this action.

  • Request (application/json)

    • Body
      {  
    "title": "react",  
    "link": "https://reactjs.org/",  
    "description": "Powerful, component-based front-end framework for JavaScript.",  
    "tags": [  
      "web",  
      "framework",  
      "JavaScript"  
    ]  
  }
    • Schema
      {  
    "$schema": "http://json-schema.org/draft/2019-09/schema#",  
    "type": "object",  
    "properties": {  
      "title": {  
        "type": "string"  
      },  
      "link": {  
        "type": "string"  
      }  
      "description": {  
        "type": "string"  
      },  
      "tags": {  
        "type": "array",  
        "items": {  
          "type": "string"  
        },  
        "minItems": 0  
      }  
    }  
  }

  • Response 201 (application/json)

    {  
  "tags": [  
    "web",  
    "framework",  
    "JavaScript"  
  ],  
  "_id": "5dcec44fd43513080ade6320",  
  "title": "react",  
  "link": "https://reactjs.org/",  
  "description": "Powerful, component-based front-end framework for JavaScript."  
}

Tool [/tools/:id]

Delete a tool [DELETE]

Deletes a tool with the specified id.

  • Response 204 (No response body)