https://github.com/dfsp-spirit/ptgl-openapi

OpenAPI specification for the API of the Protein Topology Graph Library (PTLG).
https://github.com/dfsp-spirit/ptgl-openapi

protein proteintopology secondary-structure structural-biology webserver

Last synced: 7 days ago
JSON representation

OpenAPI specification for the API of the Protein Topology Graph Library (PTLG).

• Host: GitHub
• URL: https://github.com/dfsp-spirit/ptgl-openapi
• Owner: dfsp-spirit
• License: cc0-1.0
• Created: 2024-01-29T15:30:25.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-01-30T09:40:45.000Z (9 months ago)
• Last Synced: 2024-05-01T15:40:03.683Z (6 months ago)
• Topics: protein, proteintopology, secondary-structure, structural-biology, webserver
• Homepage: http://ptgl.uni-frankfurt.de
• Size: 10.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ptgl-openapi

OpenAPI specification for the API of the Protein Topology Graph Library (PTLG).

## About the PTGL

The PTGL is a web server and database of protein structure topologies. It is based on topology graphs of different levels of abstraction that can be computed from information in the Protein Data Bank, visualized and used for further analyses.

See [ptgl.uni-frankfurt.de](http://ptgl.uni-frankfurt.de) for the PTGL service, or find the source code at [github.com/MolBIFFM/PTGLtools](https://github.com/MolBIFFM/PTGLtools).

## About this repository

This repository contains a formal API specification for the public API of the PTGL, written according to the [OpenAPI standard](https://www.openapis.org/).

Of course, this specification can be used by programmers to manually create clients. However, it can also be used with tools like Swagger to *automatically* generate API documentation as well as API clients in more than a dozen programming languages.

You can find this specification [here on swaggerhub](https://app.swaggerhub.com/apis/TimSchaefer/PTGL-API/1.0.0) and try the API live, generate documentation and clients.