[Site] Torn Api - OpenAPI3.0

I created a OpenAPI 3.0 description of the current Torn API.
I'm running it with swagger-ui on my Server, if you want to try it out.

Swagger-UI
https://jotde.be/torn-api/

git-project
https://github.com/torn-api/openapi

For further description read the README.md in the git-project.

I have noticed that very few people know the term OpenAPI. So here is the description of what OpenAPI is.

The OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined, a consumer can understand and interact with the remote service with a minimal amount of implementation logic.
An OpenAPI definition can then be used by documentation generation tools to display the API, code generation tools to generate servers and clients in various programming languages, testing tools, and many other use cases.

In the next days I will maintain examples of the API's responses and record the structure of the responses. If someone wants to join in, I can move the project to github.

Why not just use https://api.torn.com?

It's still a work in progress. But I have already published it now, so that you can get a first impression and to get helpers on board. My previous attempts to use the description language as a possible documentation base have failed due to subsequent tool discussions in the Discord API channel.

The documentation is not complete. In addition, there are no examples or structure descriptions for the responses. As I said, I will maintain this in the next few days.

For quick deployment, having no documentation on how anything works, with a trial and error interpretation from every community developer makes things easy. But that means that every developer goes through asking the same questions.

IE how to and from works, what kind of Strings to expect as the attack status, what each icon on the profile means, why can't we use to and from with events logs, what type of data is to be expected in a certain portion of the JSON object...

First Example for User -> Networth is ready.
Had some work to do with refactoring from on big yaml file to smaller files.

Also I moved the repository to github and created the organization torn-api.

[image: i.imgur.com]

Ok, Ok. I dig it.

This is good too "OK, or not OK, that is the question. (William Chedspeare)."

This is very cool, thank you for your work

This is great.Much more helpful than the official docs for people who are new to Torn's API.