3 | 
18 |
19 | REST:
20 | 
21 | ## GraphQL Elements
22 | GraphQL has some different keywords then REST. These are:
23 | - Schema
24 | - TypeDefs
25 | - Queries
26 | - Muations
27 |
28 | ### Sample JSON Data
29 | This JSON file is going to be act as a database.
30 | ```jsx
31 | [
32 | {"id":1,"pizza_name":"Cheese Pizza", "price": "10$", "ingredients":["Mushrooms","Olives","Extra Cheese"]},
33 | {"id":2,"pizza_name":"Pepperoni Pizza", "price": "12$", "ingredients":["Pepperoni","Mushrooms","Olives"]},
34 | {"id":3,"pizza_name":"Veggie Pizza", "price": "15$", "ingredients":["Mushrooms","Olives","Green Peppers","Onions","Extra Cheese"]},
35 | {"id":4,"pizza_name":"Meat Pizza", "price": "20$", "ingredients":["Pepperoni","Mushrooms","Olives","Sausage","Black Olives","Green Peppers","Onions","Extra Cheese"]},
36 | {"id":5,"pizza_name":"Margherita Pizza", "price": "10$", "ingredients":["Olives","Sausage","Black Olives"]},
37 | {"id":6,"pizza_name":"BBQ Chicken Pizza", "price": "18$", "ingredients":["Chicken","Mushrooms","Olives","Sausage","Black Olives","Green Peppers","Onions","Extra Cheese"]},
38 | {"id":7,"pizza_name":"Hawaiian Pizza", "price": "16$", "ingredients":["Mushrooms","Olives","Sausage","Black Olives","Green Peppers","Onions","Extra Cheese"]}
39 | ]
40 | ```
41 | ### Schema
42 | Schema is the place where the queries and mutations are stored. Both the front-end and back-end team can look at the schema and understand the API.
43 |
44 | You can see an example schema down below with express and GraphQL.
45 | ```jsx
46 | const Query = new GraphQLObjectType({...});
47 | const Mutation = new GraphQLObjectType({...});
48 |
49 | //Schema
50 | const schema = new GraphQLSchema({
51 | query: Query,
52 | mutation: Mutation,
53 | });
54 |
55 | app.use('/graphql', graphqlHTTP({
56 | schema,
57 | graphiql: true
58 | }));
59 | ```
60 | The graphiql boolean allows us to open a in browser API testing app.
61 |
62 | ### Type Defs
63 | Every graph uses a **schema** to define the types of data it includes. You can think of them just like type definitions from Java like **int**, **string**, **float** etc.
64 | ```jsx
65 | const PizzaType = new GraphQLObjectType({
66 | name: 'Pizza',
67 | fields: {
68 | id: {type: GraphQLInt},
69 | pizza_name: {type: GraphQLString},
70 | price: {type: GraphQLString},
71 | ingredients: {type: GraphQLList(GraphQLString)},
72 | }
73 | });
74 | ```
75 |
76 | ### Queries
77 | Queries allows us to get data from our API.
78 | ```jsx
79 | const Query = new GraphQLObjectType({
80 | name: 'Query',
81 | fields: {
82 | getAll: {
83 | type: new GraphQLList(PizzaType),
84 | resolve(parent, args) {
85 | return pizzaDB;
86 | }
87 | }
88 | }
89 | });
90 | ```
91 |
92 | The great thing about queries is that it allows us to get any data we want. If we want all the data but not the **id** we can do that with just one request in GraphQL and there won't be any unused data so it's going to prevent overfetching.
93 | ```jsx
94 | query {
95 | getAll {
96 | pizza_name
97 | price
98 | ingredients
99 | }
100 | }
101 | ```
102 | ### Mutations
103 | Mutations allows us to mutate our data. We can use mutations to update, delete and etc. inside our API. In the below example we create a mutation to add a new pizza to our pizza JSON database.
104 | ```jsx
105 | const Mutation = new GraphQLObjectType({
106 | name: 'Mutation',
107 | fields: {
108 | createNewPizza: {
109 | type: PizzaType,
110 | args: {
111 | pizza_name: {type: GraphQLString},
112 | price: {type: GraphQLString},
113 | ingredients: {type: GraphQLList(GraphQLString)}
114 | },
115 | resolve(parent, args) {
116 | pizzaDB.push({
117 | id: pizzaDB.length + 1,
118 | pizza_name: args.pizza_name,
119 | price: args.price,
120 | ingredients: args.ingredients
121 | });
122 |
123 | return args;
124 | }
125 | }
126 | }
127 | });
128 | ```
129 |
130 | At below we execute our mutation like this. We don't need to specify the ID since it automatically increases its id to the size of the JSON data. This prevents human error factor. The fallowing query inside of the **createNewPizza** will display the new items that got added.
131 | ```jsx
132 | mutation {
133 | createNewPizza(pizza_name: "New Pizza", price: "0$", ingredients: ["tomato", "pepper", "cheese"]) {
134 | id
135 | pizza_name
136 | price
137 | infredients
138 | }
139 | }
140 | ```
141 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2018 Jeremy "Jermbo" Lawson
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Sample APIs 3.1
2 |
3 | 
4 |
5 | ## Purpose
6 |
7 | Understanding RESTful APIs is hard enough, even without including an authentication mechanism. The sole purpose of this repository is to play with RESTful endpoints and learn. We have a few endpoints that you can start playing around with right away! If you are not finding anything you are interested in, create your own endpoints and/or submit a pull request. Take a look at the [CONTRIBUTING](https://github.com/jermbo/SampleAPIs/blob/master/CONTRIBUTING.md) for more information on how to get involved.
8 |
9 | # How to use the service
10 |
11 | Choose an endpoint, say "futurama", then choose what information you'd like, say "characters":
12 | ```Javascript
13 | const baseURL = "https://api.sampleapis.com/futurama/characters";
14 | fetch(baseURL)
15 | .then(resp => resp.json())
16 | .then(data => console.log(data));
17 | ```
18 |
19 | Want to Search? for all chatacters with the name "Bender"?
20 | ```Javascript
21 | const baseURL = "https://api.sampleapis.com/futurama/characters";
22 | fetch(`${baseURL}?name.first=Bender`)
23 | .then(resp => resp.json())
24 | .then(data => console.log(data));
25 | ```
26 | You also have full CRUD, so you can add information or correct existing ones.
17 |
19 |
20 |
29 |
43 | {api.metaData.title}
21 |
30 |
42 | {api.metaData.desc}
31 |
32 |
41 | See available endpoints
33 |-
34 | {api.endpoints.map((endpoint) => (
35 |
- 36 | {endpoint} 37 | 38 | ))} 39 |