# ming

> A Quasi-RESTful Web Service for MongoDB.

Latest version **0.2.1** (published 2014-01-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install ming
pnpm add ming
yarn add ming
bun add ming
```

Provides the command `ming`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.1 |
| Published | 2014-01-16 |
| First published | 2013-08-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.8.0 |
| Dependencies | 7 |
| Known vulnerabilities | 0 (+5 in 2 direct dependencies) |
| Install scripts | no |
| Author | Alexander Grüneberg |
| Maintainers | agrueneberg |

## Links

- npm: https://www.npmjs.com/package/ming
- Repository: https://bitbucket.org/agrueneberg/ming
- Issues: https://bitbucket.org/agrueneberg/ming/issues
- npm.io page: https://npm.io/package/ming

## Dependencies (7)

- [q](https://npm.io/package/q.md) ~1.0.0
- [corser](https://npm.io/package/corser.md) ~1.2.0
- [express](https://npm.io/package/express.md) ~3.2.4
- [mongodb](https://npm.io/package/mongodb.md) ~1.3.5
- [optimist](https://npm.io/package/optimist.md) ~0.5.0
- [raw-body](https://npm.io/package/raw-body.md) ~1.1.2
- [basic-auth](https://npm.io/package/basic-auth.md) ~0.0.1

## Recent versions

- 0.2.1 (latest) — 2014-01-16
- 0.2.0 — 2014-01-15
- 0.1.0 — 2013-08-13

## README

Ming
====

A Quasi-RESTful Web Service for MongoDB.

Status
------

Experimental, not well tested.

Installation
------------

- Run `sudo npm install ming -g`
- Run `ming` (see Usage)
- Put an SSL-enabled proxy in front of it

Usage
-----

- `port`: Ming Server port (default *1337*)
- `connection-string`: MongoDB [Connection String](http://docs.mongodb.org/manual/reference/connection-string/) for the default deployment (default *mongodb://localhost/ming*)

### Example

    ming --connection-string mongodb://mymongoserver/mymongodb

Clients
-------

- [Ming Fu](https://bitbucket.org/agrueneberg/ming-fu)

API
---

### Routes

#### Documents

- `GET /` retrieve collection names
- `GET /:collection` retrieve collection statistics
- `GET /:collection/:document` retrieve document
- `GET /:collection/:document/:field` retrieve field of document
- `POST /:collection/query` query documents
- `POST /:collection` create document
- `PATCH /:collection/:document` update document
- `DELETE /:collection/:document` delete document

#### Files (GridFS)

- `GET /:prefix.files/:file` retrieve metadata of file
- `GET /:prefix.files/:file?binary=true` retrieve contents of file
- `POST /:prefix.files` create file
- `DELETE /:prefix.files/:file` delete file

### Headers

- `Authorization` basic HTTP authorization (e.g. in JavaScript `"Authorization : Basic " + btoa(username + ":" + password)`)

---
_Source: https://npm.io/package/ming · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._