GraphQL API designed to create, manage and track personalized roadmaps breaking them down into manageable steps
pathwayapi-graphql.onrender.com
hosts a public instance of the API.
[!Important] Please notice this API serves the same purpose of the original one, but with a different architecture. You can find everything you need to know in this repository
Each endpoint requires prior authentication based on bearer token. This token can be obtained after signing up and/or logging and it will be needed as authorization header in every request you make.
Register
mutation Register {
register(email: "[email protected]", password: "1234567890") {
user {
id
email
createdAt
}
success
errors {
fullMessages
}
}
}
Login
mutation Login {
login(email: "[email protected]", password: "1234567890") {
errors
success
token
}
}
Use queries to obtain one object or a list of objects, like Roadmaps, Categories and Steps
query Roadmaps {
roadmaps {
id
description
title
completed
categories {
id
name
}
steps {
id
completed
description
order
roadmapId
title
}
}
}
Use mutations to create or modify an object, like Roadmaps, Steps and Tracking Steps
mutation CreateRoadmap {
createRoadmap(
title: "New Roadmap"
description: "New Roadmap Description"
categoryIds: [7, 8]
steps: [
{ title: "First Step", description: "First Description Step", order: 1 },
{ title: "Second Step", description: "Second Description Step", order: 2 }
]
) {
success
errors {
details
fullMessages
}
roadmap {
id
title
description
categories {
id
name
}
steps {
id
title
description
order
}
}
}
}
This section is for the developers who want to explore the technical characteristics of the API.
bundle install
rails db:create
and rails db:migrate
(every time there is a change in your schema)run db:seed
rails s