Skip to content

Initial Release

Choose a tag to compare

@MaxClerkwell MaxClerkwell released this 25 Feb 13:11
· 4 commits to master since this release

STEMgraph API - Current Live API

πŸš€ Version: 1.0.1

This is the current live API running on the STEMgraph server. πŸŽ‰ It provides structured access to the STEMgraph database, allowing users to interact with graph data securely and efficiently.

πŸ”₯ Key Features

  • Graph Data Retrieval: Fetch the latest graph structure with /graph.
  • Node Creation: Securely add new nodes via /node (only for authorized power users with write access).
  • FastAPI Framework: Optimized for high performance and easy extensibility.
  • Secure API Access: Uses Docker Secrets to protect credentials and API keys.
  • Automated Background Caching: Keeps graph data fresh with periodic updates.
  • Logging with Uvicorn: Consistent logging for better debugging.

πŸ›‘ Node Creation Restrictions

  • Only authenticated power users with write access can create new nodes.
  • If you need write access, please contact sboekelmann@ep1.rub.de.

πŸ“œ How to Use the API

  • The API is not meant to be run locally but is available on the STEMgraph server.
  • Users can access the API endpoints via the official server.
  • API requests must include the appropriate authentication headers.

πŸ“’ Discussion & Contribution

🎯 Upcoming Features

The following features are planned for future releases:

  • Retrieve the graph in different formats.
  • Return the shortest path between two nodes in the graph.
  • Generate and return a PDF for a specific node.
  • Return all nodes that a given node is built upon.

This API is actively maintained and improvedβ€”feedback and contributions are always welcome! πŸš€