GithubHelp home page GithubHelp logo

Comments (1)

josecelano avatar josecelano commented on June 16, 2024

hi @da2ce7 @WarmBeer, two questions:

  1. Api versions

Are we going to keep the current API version? This issue only changes Warp with Axum. I will break the API in the next issue: #144

We could keep both. Version v1 could be the current one, and version v2 could be the new one.

I'm working on building the new Axum version without changing the current one. Once we move to Axum, it will be easy to add versions, all of them using Axum.

  1. API docs

The API documentation is on the torrust.com site.

If we want to generate the API docs automatically with, for example, the utopia crate we should do it soon. Maybe after finishing the Axum implementation while I'm implementing the new API.

Here you have an example with Auxm: https://github.com/juhaku/utoipa/blob/master/examples/todo-axum/src/main.rs

Since we have to maintain docs for multiple API versions I think it's a good idea to use a tool like that. On the other hand, the API is small and it should not change very often.

from torrust-tracker.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.