https://github.com/magisteriis/riot-games-help-to-swagger-dotnet

Converts Riot Games' native help format to Swagger and OpenAPI.
https://github.com/magisteriis/riot-games-help-to-swagger-dotnet

openapi openapi-generator riot-games swagger

Last synced: 3 months ago
JSON representation

Converts Riot Games' native help format to Swagger and OpenAPI.

• Host: GitHub
• URL: https://github.com/magisteriis/riot-games-help-to-swagger-dotnet
• Owner: magisteriis
• License: unlicense
• Created: 2022-03-20T14:54:08.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-06-14T02:03:05.000Z (over 1 year ago)
• Last Synced: 2023-06-14T03:22:38.401Z (over 1 year ago)
• Topics: openapi, openapi-generator, riot-games, swagger
• Language: C#
• Homepage: https://magisteriis.github.io/riot-games-help-to-swagger-dotnet/
• Size: 4.48 MB
• Stars: 6
• Watchers: 2
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Help2Swagger (.NET)

Converts Riot Games' native help format to Swagger and OpenAPI.

# Sponsors

A big thank you for your support!

[![Sentry Logo](https://raw.githubusercontent.com/mikaeldui/riot-games-dotnet-client/main/sponsors/sentry.svg)](https://sentry.io/for/good/)

[![JetBrains Logo (Main) logo](https://raw.githubusercontent.com/mikaeldui/riot-games-dotnet-client/main/sponsors/jetbrains.svg)](https://jb.gg/OpenSourceSupport)

# How it works

1. It downloads the `/Help` in two different formats, [`Full`](https://www.mingweisamuel.com/lcu-schema/lcu/help.json) and [`Console`](https://www.mingweisamuel.com/lcu-schema/lcu/help.console.json).

    - The information needed is spread out over both representations.

2. The Helps are parsed.

3. The OpenAPI spec is constructed using parts from both Helps.

4. The spec gets serialized to JSON.