Interview Question API

Full stack interview question API

Table of contents

• Interview Question API
  • Documentation
    • GraphQL Schema
  • Considerations
    • Question Storage
  • Continuous Integration
  • Testing
    • Test Coverage

Documentation

Documentation for the API can be found at https://20jasper.github.io/interview_question_api_graphql_docs/

GraphQL Schema

A searchable reference for the API GraphQL Schema generated with GraphDoc

Considerations

Question Storage

The questions are stored in a JSON file since they will not need to change between releases, and I don't plan on adding any new questions at the moment

Continuous Integration

File	Description	Runs on
verify.yaml	Check formatting, run tests and compile code	Runs on pull request to main and called in deploy
deploy.yaml	Calls verify, deploys production build to railway, then calls publish-docs	Runs on push to main
publish-docs.yaml	Generates GraphQL docs and then pushes to the docs repo	Called in deploy

Testing

Tests can be run with cargo test

Test Coverage

To run test coverage, first install tarpaulin

cargo install cargo-tarpaulin

Then to generate HTML and XML coverage reports, run

cargo tarpaulin