https://github.com/rstropek/node-mongo-sample

A simple RESTful Web API for event- and participant management that I use in Docker and Kubernetes workshops
https://github.com/rstropek/node-mongo-sample

Last synced: 6 days ago
JSON representation

A simple RESTful Web API for event- and participant management that I use in Docker and Kubernetes workshops

• Host: GitHub
• URL: https://github.com/rstropek/node-mongo-sample
• Owner: rstropek
• License: mit
• Created: 2018-06-06T13:48:36.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-09T15:23:38.000Z (almost 2 years ago)
• Last Synced: 2023-08-14T08:11:01.296Z (about 1 year ago)
• Language: TypeScript
• Size: 715 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 12
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Node + MongoDB Sample

## Introduction

This sample image implements a simple RESTful Web API for event- and participant management. It is implemented in Node.js and uses MongoDB to store data. I use this image in Docker and Kubernetes trainings.

## Swagger and OpenAPI

This sample also contains an OpenAPI specification for the Web API. I use it in workshops to speak about Swagger and OpenAPI. Here are the links to the specifications:

* Swagger (v2)

  * [YAML on GitHub](https://github.com/rstropek/node-mongo-sample/blob/master/api2.yaml)

  * [JSON on GitHub](https://github.com/rstropek/node-mongo-sample/blob/master/api2.json)

  * [JSON raw](https://rawgit.com/rstropek/node-mongo-sample/master/api2.json)

* OpenAPI (v3)

  * [YAML on GitHub](https://github.com/rstropek/node-mongo-sample/blob/master/api3.yaml)

  * [JSON on GitHub](https://github.com/rstropek/node-mongo-sample/blob/master/api3.json)

  * [JSON raw](https://rawgit.com/rstropek/node-mongo-sample/master/api3.json)

## Quickstart

### Step 1

Pull the latest image:

```sh

docker pull rstropek/node-mongo-sample

```

### Step 2

This Web API will need a MongoDB to store data. If you don't have one, you can run it in a container:

```sh

docker run --name event-db -d mongo

```

### Step 2

Run the Web API:

```sh

docker run -e MONGO_URL=mongodb://event-db/member-management --link event-db -p 1337:80 -d --name event-api rstropek/node-mongo-sample

```

### Step 3

Try accessing the Web API. Here are some sample requests you can try:

```txt

GET http://localhost:1337/api/events?past=true

Accept: application/json

###

POST http://localhost:1337/api/events

Content-Type: application/json

Accept: application/json

{

    "date": "2018-03-21T00:00:00",

    "location": "Linz"

}

###

POST http://localhost:1337/api/events/5ab1f7783907dc5490a62a26/registrations

Content-Type: application/json

Accept: application/json

{

    "participant": 

    {

        "givenName": "John",

        "familyName": "Doe"

    }

}

###

GET http://localhost:1337/api/events/5ab1f7783907dc5490a62a26/registrations

Accept: application/json

###

POST http://localhost:1337/api/participants/5ab1f82465ab325e8356f183/checkin/5ab1f7783907dc5490a62a26

Content-Type: application/json

Accept: application/json

```