Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lccodder/places-api
Places API written in Nest.js with Mongodb
https://github.com/lccodder/places-api
api boilerplate geojson graphql nestjs nodejs rest
Last synced: about 2 months ago
JSON representation
Places API written in Nest.js with Mongodb
- Host: GitHub
- URL: https://github.com/lccodder/places-api
- Owner: LCcodder
- Created: 2024-08-09T14:31:02.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-11-23T16:19:53.000Z (about 2 months ago)
- Last Synced: 2024-11-23T17:22:07.193Z (about 2 months ago)
- Topics: api, boilerplate, geojson, graphql, nestjs, nodejs, rest
- Language: TypeScript
- Homepage:
- Size: 570 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Places API written in `Node.js`
### This is places REST API service like `geoapify` or another similar geographic API with querying and finding places in radius.
+ This API works with *role-based* auth, so if you want to create/update/delete places you must provide one of the *master keys* in `token` querystring
# Endpoints:
1. `POST:/api/v1/auth` - returns API token with expiration time
Body
```JSON
{
"email": "[email protected]"
}
```
Response
```JSON
{
"token": "",
"expiresIn": "24h"
}
```
---
2. `POST:/api/v1/places` **(admin route)** - creates place with provided fields and returns created place with generated `_id` and timestamps
Body
```JSON
{
// required
"category": "goverment",
// required
"subcategories": ["services", "police"],
// required
"datasources": ["OSM", "google maps"],
"geo": {
"coordinates": [34.312321, 62.12476456],
// required
"lat": 34.312321,
//required
"long": 62.12476456,
// required
"country": "Russia",
"country_code": "RU",
"city": "Moscow",
"region": "Khimki",
"state": "SZAO",
"state_code": "sz",
"suburb": "Leninski prospect",
"street": "Pushkinskaya",
// required
"full_address": "Moscow, Khimki, Pushkina 12/23",
"address_line1": "string",
"address_line2": "string",
"address_line3": "string",
"postcode": 123457,
"third_party": {
"google_maps_link": "",
"osm": "",
"osm_id": "asdada1231231"
}
},
"place": {
// required
"name": "Police department of Khimki",
"full_name": "GU MVD of Khimki, Moscow Oblast",
"old_name": "Deputy of Khimki",
"description": "Police department, located near west road",
"is_heritage": false,
"is_guarded": true,
"authorized_personeel_only": true,
"is_goverment_property": true,
"founded_by": "Department of Justice of Moscow",
"builded_at": "2024-08-11T15:48:00.852Z",
"construction_started_at": "2024-08-11T15:48:00.852Z",
"builded_by": "REDACTED",
"open_hours": {
"from": 0,
"to": 24
},
"is_always_open": true,
"age_from": 21,
"facilities": ["parking"],
"wikipedia": "",
"images": "http://images.com/police-department/1"
},
"contacts": {
"website": "http://khpd.ru",
"websites": ["http://khpd.ru"],
"phone_number": "911",
"phone_numbers": ["911"],
"email": "[email protected]",
"emails": ["[email protected]"],
"links": ["http://khpd.ru"]
},
"law": {
"owner": "Department Of Justice",
"owner_law_address": "ae12424",
"owner_phisycal_address": "Kremlyn",
"license": "gov12313",
"corp": "S.T.A.R.S."
}
}
```
Response
```JSON
{
"_id": "66b744dbde0cb7ff86d627ad",
"category": ...,
"subcategories": ...,
"datasources": ...,
"geo": {
...
},
"place": {
...
},
"contacts": {
...
},
"law": {
...
},
"createdAt": "2024-08-10T10:45:47.522Z",
"updatedAt": "2024-08-10T10:45:47.522Z",
"__v": 0
}
```
---
3. `PATCH:/api/v1/places` **(admin route)** - updates place with provided fields and returns updated place
Body
```JSON
{
"law": {
"owner": "Department Of Justice",
"owner_law_address": "[REDACTED]",
"owner_phisycal_address": "[REDACTED]",
"license": "[REDACTED]",
"corp": "S.T.A.R.S."
}
}
```
Response
```JSON
{
"_id": "66b744dbde0cb7ff86d627ad",
"category": ...,
"subcategories": ...,
"datasources": ...,
"geo": {
...
},
"place": {
...
},
"contacts": {
...
},
"law": {
"owner": "Department Of Justice",
"owner_law_address": "[REDACTED]",
"owner_phisycal_address": "[REDACTED]",
"license": "[REDACTED]",
"corp": "S.T.A.R.S."
},
"createdAt": "2024-08-10T10:45:47.522Z",
"updatedAt": "2024-08-10T10:45:47.522Z",
"__v": 0
}
```
---
4. `DELETE:/api/v1/places/:id` **(admin route)** - deletes place by `_id`
Response
```JSON
{
"success": true
}
```
---
5. `GET:/api/v1/places/:id` **(user route)** - returns found place by `_id`
+ Supports XML format, if you need given data to be in XML use `Content-Type`header with `application/xml`
Response
```JSON
{
"_id": "66b744dbde0cb7ff86d627ad",
"category": ...,
"subcategories": ...,
"datasources": ...,
"geo": {
...
},
"place": {
...
},
"contacts": {
...
},
"law": {
...
},
"createdAt": "2024-08-10T10:45:47.522Z",
"updatedAt": "2024-08-10T10:45:47.522Z",
"__v": 0
}
```
---
6. `GET:/api/v1/places` **(user route)** - returns places by provided options
+ Supports XML format, if you need given data to be in XML use `Content-Type`header with `application/xml`
Options
| Querystring | Description | Example value |
|--------------------|------------------------------------------------------------------|------------------------------|
| **category** | _Filters place by category_ | `shops` |
| **subcategories** | _Adds additional categories, that can be divided by "."_ | `groceries.vegan` |
| **city** | _Filters place by city (case is necessary)_ | `Moscow` |
| **country** | _Filters place by country (case is necessary)_ | `Russia` |
| **state** | _Filters place by state (case is necessary)_ | `Arizona` |
| **state_code** | _Filters place by shortened state_ | `AZ` |
| **region** | _Filters place by state region (case is necessary)_ | `Glendale` |
| **postcode** | _Filters place by postcode (must be number)_ | `123133` |
| **builded_by** | _Filters place by creator/builder_ | `Stanford Professor` |
| **open_from** | _Filters by place opening hours (24h format)_ | `10` |
| **open_to** | _Filters by place closing hours (24h format)_ | `23` |
| **is_always_open** | _Filters only always-open places (1 or 0)_ | `1` |
| **age_from** | _Filters by place minimal allowed age to enter (must be number)_ | `18` |
| **facilities** | _Filters by place facilities such as parking (string array)_ | `parking` `disabled_support` |
| **owner** | _Filters by place owner_ | `Donald Trump` |
| **license** | _Filters by place license (or any law document)_ | `gambling_license` |
| **corp** | _Filters place by owning corp_ | `Apple` |
| **sort** | _Sorts places bu build date (1 or -1)_ | `-1` |
| **limit** | _Pagination limit_ | `1` |
| **offset** | _Pagination offset_ | `2` |
Response
```JSON
[
{
"_id": ...,
"category": ...,
"subcategories": ...,
"datasources": ...,
"geo": {
...
},
"place": {
...
},
"contacts": {
...
},
"law": {
...
},
"createdAt": ...,
"updatedAt": ...,
"__v": 0
},
{
"_id": ...,
"category": ...,
"subcategories": ...,
"datasources": ...,
"geo": {
...
},
"place": {
...
},
"contacts": {
...
},
"law": {
...
},
"createdAt": ...,
"updatedAt": ...,
"__v": 0
}
]
```
# Graphql
### API supports Graphql query on finding multiple places or one place by id
+ You can found schema at `/src/api/graphql/schemas/place.graphql`
+ To access Graphql use `/api/v1/graphql` endpoint
+ `places` query supports all options that in http endpoint
+ To provide api token use `token` header, unlike queryparam in http endpoint
# Launch
1. Copy this repo
```shell
git clone https://github.com/LCcodder/places-api
```
2. Install packages
```shell
npm i
```
3. Configure environment variables in `.env` file
4. Make sure you running `Mongodb`
5. Run app
```shell
npm start
```
OR
1. Copy this repo
```shell
git clone https://github.com/LCcodder/places-api
```
2. Run Docker compose:
```shell
docker compose up --build
```
---
### Made by [LCcodder](https://github.com/LCcodder)