Maintain your API development, documentation and experimentation all within your codebase.

Overview

npm version Publish to NPM weekly downloads from npm

dostman

Maintain your API development, documentation and experimentation all within your codebase.

  • This project is a new release! Feel free to contact me @egecavusoglu to collaborate or see Project Plan for to do items. Pull requests welcome!

Why dostman instead of Postman?

  • Remove the need of an external app.
  • Don't deal with Postman's business logic or plan restrictions.
  • Get formatted output of your API requests in JSON, use & distribute it anywhere you like.
  • Track your API documentation with your project's version management. No more outdated API docs!

Installation

You can install dostman as a dev dependency to your project like this.

npm i -D dostman 

Or globally like this

npm i -g dostman

How to use

  1. Create files with .dostman extension file in following format. Find a more detailed how to use guide at sample usage.
  • @desc: Description of your endpoint
  • @method: HTTP method of the request (GET | POST | PUT | DELETE)
  • @headers: Specify headers, seperated by commas , .
  • @body: Specify request body as JSON.

To see example .dostman files visit sample-requests.

  1. Run dostman at the root of your directory.
  • If installed globally
dostman
  • If installed as a dev dependency: Add a script to your package.json
"scripts": {
    "dostman": "dostman"
  },

Dostman will find all files under the directory ending with .dostman extension, execute your requests and give you API docs.

Configure your dostman file with @config

Are you also tired of refreshing tokens for requests whenever you open your project after a while? Or want randomized variables? You can save your variables as functions to automate the process.

Dostman will evaluate your config as JavaScript and replace your variables with your exported values.

@config
const SERVER_URL = `https://jsonplaceholder.typicode.com/todos/1`;
const variable_as_func = () => 555;

exports = {SERVER_URL, variable_as_func};

###
You might also like...

Codú's open-source codebase. A space for coders.

Running the app $ npm install # development $ npm run dev Open http://localhost:3000 with your browser to see the result. You can start editing the p

Jan 2, 2023

A wrapper for valorant-api, a third-party API for getting data within Valorant. Available on npm

valorant-wrapper A wrapper for the third-party valorant-api How to Use All endpoints can be accessed off the ValAPI class. import { ValAPI } from 'val

Nov 7, 2022

Supercharge your All-in-One workspace with the Command Palette within Notion 🕹️

Supercharge your All-in-One workspace with the Command Palette within Notion 🕹️

Notion Palette Supercharge your All-in-One workspace with the Command Palette within Notion 🕹️ Notion Palette is a free and open source extension, yo

Nov 10, 2022

The project integrates workflow engine, report engine and organization authority management background, which can be applied to the development of OA, HR, CRM, PM and other systems. With tlv8 IDE, business system development, testing and deployment can be realized quickly.

The project integrates workflow engine, report engine and organization authority management background, which can be applied to the development of OA, HR, CRM, PM and other systems. With tlv8 IDE, business system development, testing and deployment can be realized quickly.

介绍 项目集成了工作流引擎、报表引擎和组织机构权限管理后台,可以应用于OA、HR、CRM、PM等系统开发。配合使用tlv8 ide可以快速实现业务系统开发、测试、部署。 后台采用Spring MVC架构简单方便,前端使用流行的layui界面美观大方。 采用组件开发技术,提高系统的灵活性和可扩展性;采

Dec 27, 2022

Dynamic-web-development - Dynamic web development used CSS and HTML

Dynamic-web-development - Dynamic web development used CSS and HTML

Dynamic-web-development ASSISNMENT I just used CSS and HTML to make a mobile int

Feb 8, 2022

Hacktoberfest is all about meeting up all brains. In this repository we are planning to come with many ideas and works. You all can share your ides/works here.

Hacktoberfest is all about meeting up all brains. In this repository we are planning to come with many ideas and works. You all can share your ides/works here.

Hacktoberfest Submit your Work Hacktoberfest is all about meeting up all brains. In this repository we are planning to come with many ideas and works.

Oct 5, 2022

Preview and reply to your messages from within Alfred. Keep your hands on that keyboard!

Preview and reply to your messages from within Alfred. Keep your hands on that keyboard!

Mouseless Messenger Mouseless Messenger offers you rapid keyboard-driven access to send and read conversations in the macOS Messages app via Alfred —

Dec 30, 2022

Swagger UI is a collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.

Swagger UI is a collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.

Introduction Swagger UI allows anyone — be it your development team or your end consumers — to visualize and interact with the API’s resources without

Dec 28, 2022

Search your code and 2M+ public repositories on Sourcegraph directly within Raycast.

 Search your code and 2M+ public repositories on Sourcegraph directly within Raycast.

Sourcegraph for Raycast Search your code and 2M+ public repositories on Sourcegraph directly within Raycast. Install · Setup · Commands · Issues · Cha

Jul 10, 2022
Releases(1.0.3)
Owner
Ege Çavuşoğlu
Senior computer science student. JS, TS and some Swift. Co founder @chember.co. Interning at @microsoft.
Ege Çavuşoğlu
A scalable, high-performance feature management and progressive experimentation platform

Introduction & Our Philosophy FeatBit is a scalable, high-performance Feature Management and Progressive Experimentation platform. Feature Management

null 345 Jan 1, 2023
4WEB is a collection & creation of codebase, frameworks, libraries and various resources dedicated to web development 📦🌐

?? Vous pouvez également contribuer à ajouter/créer votre propre collection dans ce référentiel ... Table des matières ?? Codebase ?? NPM packages ??

Raja Rakotonirina 5 Nov 14, 2022
4Web is a collection&creation of codebase, frameworks, libraries dedicated to web development 📦

?? You can also contribute to add / create your own collection in this repository Collection name Description ?? blinke

Raja Rakotonirina 5 Nov 14, 2022
Tumaini Maganiko 7 May 9, 2023
A robust and light-weight inventory management application designed to help businesses maintain perfect control over every unit of stock.

Inventory Buddy Access inventory anytime on web, tablet or mobile. Inventory Buddy is a robust and light-weight inventory management application desig

Brynn Smith 7 Nov 5, 2022
Use PageRank to find the most important files in your codebase.

Deprank Deprank uses the PageRank algorithm to find the most important files in your JavaScript or TypeScript codebase. It uses dependency-cruiser to

codemix 680 Dec 30, 2022
Astrospeed is a performance monitor for your AstroJS codebase.

astroSpeed astroSpeed Performance monitor for Astro & Next.js web applications. Explore astrospeed.io » View Demo · Report Bug · Request Feature Table

OSLabs Beta 38 Dec 15, 2022
The iofod SDK provides developers with the ability to interact with the main iofod interface within the Web worker, enabling rapid development of iofod extensions through the SDK.

iofod-sdk English | 简体中文 The iofod SDK provides developers with the ability to interact with the main iofod interface within the Web worker, enabling

iofod, Inc. 47 Oct 17, 2022
A framewok for building efficient and scalable, cross-platform bots (WhatsApp, Discord, Telegram and more) in a single codebase

project... An over-engineered all-in-one bot framewok for building efficient and scalable bots. Yep that's not a typo u heard it right "scalable bots"

Shubham Badgujar 6 Dec 24, 2022
freeCodeCamp.org's open source codebase and curriculum. Learn to code for free.

freeCodeCamp.org's open-source codebase and curriculum freeCodeCamp.org is a friendly community where you can learn to code for free. It is run by a d

freeCodeCamp.org 359.2k Jan 7, 2023