Skip to content

Commit 99dd00e

Browse files
committed
docs: updated README about SDKs, API documentations and Profobuf
Signed-off-by: Neko Ayaka <neko@ayaka.moe>
1 parent 7c3941c commit 99dd00e

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@
5353
- [x] `/whisper`
5454
- [x] `/whitelist`
5555
- [ ] `/cheat`
56-
- [ ] `/command` / `/c`
56+
- [x] `/command` / `/c`
5757
- [ ] `/measured-command`
5858
- [ ] `/silent-command`
5959

@@ -146,9 +146,24 @@ to get the version of the Factorio game server.
146146

147147
## API
148148

149+
For API documentation, we offer Scalar powered OpenAPI UI under `/apis/docs` endpoint.
150+
151+
With the demo server at [https://factorio-rcon-api.ayaka.io/apis/docs](https://factorio-rcon-api.ayaka.io/apis/docs) live, you can view the full API documentations there, or you can run the API server locally and access the documentation at [http://localhost:24180/apis/docs](http://localhost:24180/apis/docs).
152+
153+
Alternatively, we ship the OpenAPI v2 and v3 spec in the repository:
154+
149155
- OpenAPI v2 spec: [v1.swagger.json](https://github.com/nekomeowww/factorio-rcon-api/blob/main/apis/factorioapi/v1/v1.swagger.json)
150156
- OpenAPI v3 spec: [v1.swagger.v3.yaml](https://github.com/nekomeowww/factorio-rcon-api/blob/main/apis/factorioapi/v1/v1.swagger.v3.yaml)
151157

158+
For developers working with the APIs from Factorio RCON API, you can either use the above OpenAPI specs or use Protobuf files to generate types for TypeScript, Python, Go, and many more languages' SDKs with code generators. We are not going to cover all of these in this README, but you can find more information on the internet:
159+
160+
- [Stainless | Generate best-in-class SDKs](https://www.stainlessapi.com/) (used by OpenAI, Cloudflare, etc.)
161+
- [Generated SDKs](https://buf.build/docs/bsr/generated-sdks/overview/)
162+
- [Hey API](https://heyapi.dev/)
163+
164+
> [!TIP]
165+
> Additionally, we can ship the SDKs for Lua, TypeScript and Python (widely used for mods, admin panels, bots) in the future, you are welcome to contribute to the project.
166+
152167
## Star History
153168

154169
[![Star History Chart](https://api.star-history.com/svg?repos=nekomeowww/factorio-rcon-api&type=Date)](https://star-history.com/#nekomeowww/factorio-rcon-api&Date)

0 commit comments

Comments
 (0)