afa-api-client
v0.1.20250830195858
Published
OpenAPI client for afa-api-client
Maintainers
Readme
[email protected]
This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:
Environment
- Node.js
- Webpack
- Browserify
Language level
- ES5 - you must have a Promises/A+ library installed
- ES6
Module system
- CommonJS
- ES6 module system
It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)
Building
To build and compile the typescript sources to javascript use:
npm install
npm run buildPublishing
First build the package then run npm publish
Consuming
navigate to the folder of your consuming project and run one of the following commands.
published:
npm install [email protected] --saveunPublished (not recommended):
npm install PATH_TO_GENERATED_PACKAGE --saveDocumentation for API Endpoints
All URIs are relative to http://localhost:5000
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- AdminCoursesApi | apiAdminCoursesGet | GET /api/admin/courses | Get all courses with filtering and pagination (Admin only) AdminCoursesApi | apiAdminCoursesIdDelete | DELETE /api/admin/courses/{id} | Delete course (Admin only) AdminCoursesApi | apiAdminCoursesIdLecturesGet | GET /api/admin/courses/{id}/lectures | Get all lectures for a specific course (Admin only) AdminCoursesApi | apiAdminCoursesIdRegisterPost | POST /api/admin/courses/{id}/register | Register user to course (Admin only) AdminCoursesApi | apiAdminCoursesPost | POST /api/admin/courses | Create a new course (Admin only) AdminPostApi | apiAdminPostsIdDelete | DELETE /api/admin/posts/{id} | Delete post (Admin only) AdminPostApi | apiAdminPostsPost | POST /api/admin/posts | Create a new post or announcement (Admin only) AdminTeacherApi | apiAdminTeachersGet | GET /api/admin/teachers | Get all teachers with filtering and pagination (Admin only) AdminTeacherApi | apiAdminTeachersIdDelete | DELETE /api/admin/teachers/{id} | Delete teacher (Admin only) AdminTeacherApi | apiAdminTeachersIdGet | GET /api/admin/teachers/{id} | Get specific teacher by ID (Admin only) AdminTeacherApi | apiAdminTeachersIdPasswordPut | PUT /api/admin/teachers/{id}/password | Change teacher password with admin verification (Admin only) AdminTeacherApi | apiAdminTeachersIdPut | PUT /api/admin/teachers/{id} | Update teacher information (Admin only) AdminTeacherApi | apiAdminTeachersPost | POST /api/admin/teachers | Create a new teacher account (Admin only) AdminUserApi | apiAdminUsersGet | GET /api/admin/users | Get all users with filtering and pagination (Admin only) AdminUserApi | apiAdminUsersIdDelete | DELETE /api/admin/users/{id} | Delete user (Admin only) AdminUserApi | apiAdminUsersIdGet | GET /api/admin/users/{id} | Get specific user by ID (Admin only) AdminUserApi | apiAdminUsersIdPasswordPut | PUT /api/admin/users/{id}/password | Change user password with admin verification (Admin only) AdminUserApi | apiAdminUsersIdPut | PUT /api/admin/users/{id} | Update user information (Admin only) AdminUserApi | apiAdminUsersIdStatusPatch | PATCH /api/admin/users/{id}/status | Update user active status (Admin only) AdminUserApi | apiAdminUsersPost | POST /api/admin/users | Create a new user account (Admin only) AuthenticationApi | apiAuthAdminLoginPost | POST /api/auth/admin/login | Admin or Teacher login AuthenticationApi | apiAuthLoginPost | POST /api/auth/login | User login for all roles AuthenticationApi | apiAuthMeGet | GET /api/auth/me | Get current authenticated user profile PostsApi | apiPostsFeaturedGet | GET /api/posts/featured | Get the featured post for homepage (public access) PostsApi | apiPostsGet | GET /api/posts | Get all posts with pagination and filtering (public access) PostsApi | apiPostsIdGet | GET /api/posts/{id} | Get single post by ID with view tracking (public access) TeachersApi | apiTeachersChangePasswordPost | POST /api/teachers/change-password | Change teacher password (requires old password verification) TeachersApi | apiTeachersCoursesGet | GET /api/teachers/courses | Get teacher's courses with detailed information TeachersApi | apiTeachersCoursesIdLecturesPost | POST /api/teachers/courses/{id}/lectures | Add lecture to course (Admin or Teacher) TeachersApi | apiTeachersDashboardGet | GET /api/teachers/dashboard | Get teacher dashboard with statistics and recent activity TeachersApi | apiTeachersIdCoursesGet | GET /api/teachers/{id}/courses | Get specific teacher's courses (Admin or Teacher) TeachersApi | apiTeachersProfileGet | GET /api/teachers/profile | Get teacher profile with courses and statistics UsersApi | apiUsersChangePasswordPost | POST /api/users/change-password | Change user password (requires old password) UsersApi | apiUsersCoursesGet | GET /api/users/courses | Get user's registered courses UsersApi | apiUsersCoursesIdGet | GET /api/users/courses/{id} | Get course details with lectures (only if user is registered) UsersApi | apiUsersMeGet | GET /api/users/me | Get user profile and registered courses
Documentation For Models
- AdminChangePasswordRequest
- ApiAdminCoursesGet200Response
- ApiAdminCoursesGet200ResponseData
- ApiAdminCoursesIdDelete200Response
- ApiAdminCoursesIdLecturesGet200Response
- ApiAdminCoursesIdLecturesGet200ResponseData
- ApiAdminCoursesIdRegisterPost200Response
- ApiAdminCoursesIdRegisterPost200ResponseData
- ApiAdminCoursesPost201Response
- ApiAdminCoursesPost201ResponseData
- ApiAdminCoursesPostRequest
- ApiAdminPostsIdDelete200Response
- ApiAdminPostsPost201Response
- ApiAdminPostsPost201ResponseData
- ApiAdminTeachersGet200Response
- ApiAdminTeachersGet200ResponseData
- ApiAdminTeachersGet200ResponseDataTeachersInner
- ApiAdminTeachersGet200ResponseDataTeachersInnerStatistics
- ApiAdminTeachersIdDelete200Response
- ApiAdminTeachersIdGet200Response
- ApiAdminTeachersIdPasswordPut200Response
- ApiAdminTeachersIdPasswordPutRequest
- ApiAdminTeachersIdPut200Response
- ApiAdminTeachersIdPutRequest
- ApiAdminTeachersPost201Response
- ApiAdminTeachersPost201ResponseData
- ApiAdminTeachersPostRequest
- ApiAdminUsersGet200Response
- ApiAdminUsersGet200ResponseData
- ApiAdminUsersIdDelete200Response
- ApiAdminUsersIdGet200Response
- ApiAdminUsersIdPasswordPut200Response
- ApiAdminUsersIdPasswordPut200ResponseData
- ApiAdminUsersIdPasswordPutRequest
- ApiAdminUsersIdPut200Response
- ApiAdminUsersIdPutRequest
- ApiAdminUsersIdStatusPatch200Response
- ApiAdminUsersPost201Response
- ApiAdminUsersPost201ResponseData
- ApiAuthMeGet200Response
- ApiPostsFeaturedGet200Response
- ApiPostsGet200Response
- ApiPostsGet200ResponseData
- ApiPostsIdGet200Response
- ApiTeachersCoursesGet200Response
- ApiTeachersCoursesGet200ResponseData
- ApiTeachersCoursesGet200ResponseDataCoursesInner
- ApiTeachersCoursesGet200ResponseDataCoursesInnerAllOfLecturesInner
- ApiTeachersCoursesGet200ResponseDataTeacher
- ApiTeachersCoursesIdLecturesPost201Response
- ApiTeachersCoursesIdLecturesPost201ResponseData
- ApiTeachersCoursesIdLecturesPost201ResponseDataCourse
- ApiTeachersCoursesIdLecturesPost201ResponseDataLecture
- ApiTeachersDashboardGet200Response
- ApiTeachersDashboardGet200ResponseData
- ApiTeachersDashboardGet200ResponseDataRecentActivity
- ApiTeachersDashboardGet200ResponseDataRecentActivityCoursesInner
- ApiTeachersDashboardGet200ResponseDataRecentActivityLecturesInner
- ApiTeachersDashboardGet200ResponseDataTeacher
- ApiTeachersIdCoursesGet200Response
- ApiTeachersIdCoursesGet200ResponseData
- ApiTeachersIdCoursesGet200ResponseDataTeacher
- ApiTeachersProfileGet200Response
- ApiTeachersProfileGet200ResponseData
- ApiTeachersProfileGet200ResponseDataCoursesInner
- ApiUsersCoursesIdGet200Response
- ApiUsersCoursesIdGet200ResponseData
- ApiUsersCoursesIdGet200ResponseDataCourse
- ApiUsersMeGet200Response
- ApiUsersMeGet200ResponseData
- ChangePasswordRequest
- Course
- CourseLecturesInner
- CreateCourseRequest
- CreateLectureRequest
- CreatePostRequest
- CreateUserRequest
- ErrorResponse
- ErrorResponseError
- Lecture
- LoginRequest
- LoginResponse
- LoginResponseData
- PaginatedResponse
- PaginatedResponseData
- Pagination
- Post
- RegisterUserRequest
- Statistics
- SuccessResponse
- UpdateUserStatusRequest
- User
Documentation For Authorization
Authentication schemes defined for the API:
bearerAuth
- Type: Bearer authentication (JWT)
