cyberpresidentvanellope/tgstation-server
1
0
Fork 0
mirror of https://github.com/tgstation/tgstation-server.git synced 2026-08-26 22:48:20 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update API documentation page

Browse Source
This commit is contained in:
Jordan Brown
2020-01-10 00:01:10 -05:00
parent 7ec46398f2
commit e381b2e1d3
1 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/API.dox
+8
View File
@@ -3,6 +3,14 @@
@tableofcontents
@section api_swag OpenAPI Spec
TGS4 has a, from code, generated OpenAPI 3.0 specification. It is much more authorative than these documents.
The most up to date version should be found here: https://raw.githubusercontent.com/tgstation/tgstation-server/gh-pages/swagger.json
You can use the API explorer SwaggerUI to interact with it: https://petstore.swagger.io
@section api_intro Introduction
The TGS4 API is designed to be a fully realized RESTful service. Once hosted, follow the specified protocol for developing new clients or one off requests that provide full control over the server