Skip to content

xApi Spec implementation using OpenAPI and swagger. Aim is to save you time in generating a RESTful APi and focusing on the LRS logic in the swagger supported languages.

License

Notifications You must be signed in to change notification settings

getaclue00/xApi-Spec-Swagger

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 

Repository files navigation

xApi-Spec-Swagger

What

This project is an attempt at the xApi Spec implementation using OpenAPI and Swagger.

This is a WIP. I'm developing this on my free time. If you notice any errata, please feel free to submit issues (with proposals) or a pull request.

There are several implementations of the xApi Spec available (just do a search on github). However, the problem is that they are implemented in a specific language or framework. Since xApi is a specification, all of the projects should be similar and there shouldn't be much duplication going on. Moreover, there is currently a lack of open source LRS implementations for the various languages and frameworks.

Why

Through this project, I am hoping to remove this barrier. The aim of this implementation is to save you time in generating a RESTful APi that is conformant to xApi Spec. Thus, you can focus your resources on the LRS business logic implementation. Conveniently, ADL LRS or LearningLocker projects can be then used as a template to building the aforementioned business logic. I sincerely hope this will save you, both, time and money.

How

  1. By using this implementation and Swagger, you will be able to quickly generate a new project and create your RESTful APi that is conformant to xApi Spec.
  2. Then, you will be able to save some money if you need to have an internal LRS, low on funds, or just for experimentation. There will be no need to rely on external resources as long as this spec is kept up to date with xApi Spec.

Other Swagger Project

TryxAPI/xapi-swagger - updated 2 years ago with 1.0.2 (vs. 1.0.3 current)

Note

This is meant to be complimentary to the various current solutions. There are obvious benefits in purchasing the off-the-shelf products. However, since this is a specification... there shouldn't be much drastic change once implemented.

About

xApi Spec implementation using OpenAPI and swagger. Aim is to save you time in generating a RESTful APi and focusing on the LRS logic in the swagger supported languages.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published