https://github.com/ahmedalatawi/nodejs-graphql-fake-api
Fake and reliable API data provider implemented in NodeJS, GraphQL, Prisma, MongoDB and Typescript
https://github.com/ahmedalatawi/nodejs-graphql-fake-api
graphql jest mongodb nodejs prisma typescript
Last synced: 3 months ago
JSON representation
Fake and reliable API data provider implemented in NodeJS, GraphQL, Prisma, MongoDB and Typescript
- Host: GitHub
- URL: https://github.com/ahmedalatawi/nodejs-graphql-fake-api
- Owner: ahmedalatawi
- Created: 2024-06-03T06:30:30.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-27T18:25:21.000Z (7 months ago)
- Last Synced: 2024-10-27T22:35:42.084Z (7 months ago)
- Topics: graphql, jest, mongodb, nodejs, prisma, typescript
- Language: TypeScript
- Homepage: https://nodejs-graphql-fake-api.vercel.app/graphql
- Size: 933 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# NodeJS GraphQL Fake API Data Provider
This is a free online **GraphQL API** for providing fake and reliable data for testing and prototyping. It's built with NodeJS, GraphQL, TypeScript, MongoDB and Prisma (see demo documentation [here](https://documenter.getpostman.com/view/35959656/2sA3kdBdBt)).
The API currently returns the top 45 most popular and none-editable actores and actresses. See demo below:
### [Demo using Postman](https://www.postman.com/altimetry-geoscientist-3938507/workspace/fake-api-data-provider-workspace/collection/35959656-ba1f465c-25fe-412f-875e-bac82c85157c?action=share&creator=35959656) :movie_camera:
**_Feel free to add, edit, or delete your own celebrities as you wish._**
## Run app locally
### 1. Clone this repo & set up MongoDB
You'll need to set up a MongoDB that supports replica set operations. For example, you can use MongoDB Atlas, see more details [here](https://www.mongodb.com/docs/atlas/).
Create a `.env` file in the project's root directory, and add the database URL as described in `.env.example` file.
### 2. Install dependencies & run app
Run `yarn` to install Node dependencies, and `yarn prisma generate` to generate **Prisma Client**, then:
### `yarn dev`
Open [http://localhost:4000/graphql](http://localhost:4000/graphql) to view it in the browser.
The is the GraphQL playground page used for testing locally, where you can also find info about the **Schema**, **Mutations**, **Queries**, etc.
#### Retrieve all celebrities
```graphql
query {
celebrities {
id
name
bio
dateOfBirth
birthPlace
photoUrl
editable
}
}
```
See more API operations
#### Retrieve a single celebrity by ID
You can retrieve a single celebrity by passing the id:
```graphql
query {
celebrity(id: "__CELEBRITY_ID__") {
id
...
}
}
```
#### Create a new celebrity
This mutation creates a new celebrity by passing the celebrity object:
```graphql
mutation {
createCelebrity(celebrity: {name: "__NAME__", bio: "__BIO__", dateOfBirth: "__DATE_OF_BIRTH__", birthPlace: "__BIRTH_PLACE__", photoUrl: "__PHOTO_URL__", editable: "__EDITABLE__"}) {
id
...
}
}
```
#### Update an existing celebrity
This mutation updates an existing celebrity by passing the id along with the properties to update:
```graphql
mutation {
updateCelebrity(celebrity: {id: "__ID__", name: "__NAME__", bio: "__BIO__", dateOfBirth: "__DATE_OF_BIRTH__", birthPlace: "__BIRTH_PLACE__", photoUrl: "__PHOTO_URL__"}) {
id
...
}
}
```
#### Delete an existing celebrity
This mutation deletes an existing celebrity by passing the id:
```graphql
mutation {
deleteCelebrity(id: "__ID__") {
id
...
}
}
```
#### Delete all existing celebrities
This mutation deletes all existing celebrities:
```graphql
mutation {
deleteAllCelebrities {
count
}
}
```
## Run tests locally
### `yarn test`
This runs all unit tests locally.
### Author :books:
[Ahmed Alatawi](https://github.com/AhmedAlatawi)