mirror of
https://github.com/zoriya/Kyoo.git
synced 2025-07-07 18:24:14 -04:00
Remove the /api prefix
This commit is contained in:
parent
f6557e6bbc
commit
25ceac2ef4
@ -40,7 +40,7 @@ namespace Kyoo.Authentication.Views
|
|||||||
/// Sign in, Sign up or refresh tokens.
|
/// Sign in, Sign up or refresh tokens.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
[ApiController]
|
[ApiController]
|
||||||
[Route("api/auth")]
|
[Route("auth")]
|
||||||
[ApiDefinition("Authentication", Group = UsersGroup)]
|
[ApiDefinition("Authentication", Group = UsersGroup)]
|
||||||
public class AuthApi : ControllerBase
|
public class AuthApi : ControllerBase
|
||||||
{
|
{
|
||||||
|
@ -31,8 +31,8 @@ namespace Kyoo.Core.Api
|
|||||||
/// <summary>
|
/// <summary>
|
||||||
/// An API to retrieve or edit configuration settings
|
/// An API to retrieve or edit configuration settings
|
||||||
/// </summary>
|
/// </summary>
|
||||||
[Route("api/configuration")]
|
[Route("configuration")]
|
||||||
[Route("api/config", Order = AlternativeRoute)]
|
[Route("config", Order = AlternativeRoute)]
|
||||||
[ApiController]
|
[ApiController]
|
||||||
[PartialPermission("Configuration", Group = Group.Admin)]
|
[PartialPermission("Configuration", Group = Group.Admin)]
|
||||||
[ApiDefinition("Configuration", Group = AdminGroup)]
|
[ApiDefinition("Configuration", Group = AdminGroup)]
|
||||||
|
@ -32,8 +32,8 @@ namespace Kyoo.Core.Api
|
|||||||
/// <summary>
|
/// <summary>
|
||||||
/// An endpoint to list and run tasks in the background.
|
/// An endpoint to list and run tasks in the background.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
[Route("api/tasks")]
|
[Route("tasks")]
|
||||||
[Route("api/task", Order = AlternativeRoute)]
|
[Route("task", Order = AlternativeRoute)]
|
||||||
[ApiController]
|
[ApiController]
|
||||||
[ResourceView]
|
[ResourceView]
|
||||||
[PartialPermission("Task", Group = Group.Admin)]
|
[PartialPermission("Task", Group = Group.Admin)]
|
||||||
|
@ -19,11 +19,8 @@
|
|||||||
using System;
|
using System;
|
||||||
using System.Collections.Generic;
|
using System.Collections.Generic;
|
||||||
using System.Linq;
|
using System.Linq;
|
||||||
using Kyoo.Abstractions;
|
|
||||||
using Kyoo.Abstractions.Models;
|
using Kyoo.Abstractions.Models;
|
||||||
using Microsoft.AspNetCore.Mvc;
|
using Microsoft.AspNetCore.Mvc;
|
||||||
using Microsoft.Extensions.Configuration;
|
|
||||||
using Microsoft.Extensions.DependencyInjection;
|
|
||||||
|
|
||||||
namespace Kyoo.Core.Api
|
namespace Kyoo.Core.Api
|
||||||
{
|
{
|
||||||
|
@ -34,30 +34,21 @@ namespace Kyoo.Core.Api
|
|||||||
/// </summary>
|
/// </summary>
|
||||||
private readonly IHttpContextAccessor _httpContextAccessor;
|
private readonly IHttpContextAccessor _httpContextAccessor;
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// The options containing the public URL of kyoo, given to <see cref="JsonSerializerContract"/>.
|
|
||||||
/// </summary>
|
|
||||||
private readonly IOptions<BasicOptions> _options;
|
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Create a new <see cref="JsonOptions"/>.
|
/// Create a new <see cref="JsonOptions"/>.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <param name="httpContextAccessor">
|
/// <param name="httpContextAccessor">
|
||||||
/// The http context accessor given to the <see cref="JsonSerializerContract"/>.
|
/// The http context accessor given to the <see cref="JsonSerializerContract"/>.
|
||||||
/// </param>
|
/// </param>
|
||||||
/// <param name="options">
|
public JsonOptions(IHttpContextAccessor httpContextAccessor)
|
||||||
/// The options containing the public URL of kyoo, given to <see cref="JsonSerializerContract"/>.
|
|
||||||
/// </param>
|
|
||||||
public JsonOptions(IHttpContextAccessor httpContextAccessor, IOptions<BasicOptions> options)
|
|
||||||
{
|
{
|
||||||
_httpContextAccessor = httpContextAccessor;
|
_httpContextAccessor = httpContextAccessor;
|
||||||
_options = options;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <inheritdoc />
|
/// <inheritdoc />
|
||||||
public void Configure(MvcNewtonsoftJsonOptions options)
|
public void Configure(MvcNewtonsoftJsonOptions options)
|
||||||
{
|
{
|
||||||
options.SerializerSettings.ContractResolver = new JsonSerializerContract(_httpContextAccessor, _options);
|
options.SerializerSettings.ContractResolver = new JsonSerializerContract(_httpContextAccessor);
|
||||||
options.SerializerSettings.Converters.Add(new PeopleRoleConverter());
|
options.SerializerSettings.Converters.Add(new PeopleRoleConverter());
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -22,9 +22,7 @@ using System.ComponentModel;
|
|||||||
using System.Reflection;
|
using System.Reflection;
|
||||||
using Kyoo.Abstractions.Models;
|
using Kyoo.Abstractions.Models;
|
||||||
using Kyoo.Abstractions.Models.Attributes;
|
using Kyoo.Abstractions.Models.Attributes;
|
||||||
using Kyoo.Core.Models.Options;
|
|
||||||
using Microsoft.AspNetCore.Http;
|
using Microsoft.AspNetCore.Http;
|
||||||
using Microsoft.Extensions.Options;
|
|
||||||
using Newtonsoft.Json;
|
using Newtonsoft.Json;
|
||||||
using Newtonsoft.Json.Serialization;
|
using Newtonsoft.Json.Serialization;
|
||||||
|
|
||||||
@ -43,20 +41,13 @@ namespace Kyoo.Core.Api
|
|||||||
/// </summary>
|
/// </summary>
|
||||||
private readonly IHttpContextAccessor _httpContextAccessor;
|
private readonly IHttpContextAccessor _httpContextAccessor;
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// The options containing the public URL of kyoo.
|
|
||||||
/// </summary>
|
|
||||||
private readonly IOptions<BasicOptions> _options;
|
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Create a new <see cref="JsonSerializerContract"/>.
|
/// Create a new <see cref="JsonSerializerContract"/>.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <param name="httpContextAccessor">The http context accessor to use.</param>
|
/// <param name="httpContextAccessor">The http context accessor to use.</param>
|
||||||
/// <param name="options">The options containing the public URL of kyoo.</param>
|
public JsonSerializerContract(IHttpContextAccessor httpContextAccessor)
|
||||||
public JsonSerializerContract(IHttpContextAccessor httpContextAccessor, IOptions<BasicOptions> options)
|
|
||||||
{
|
{
|
||||||
_httpContextAccessor = httpContextAccessor;
|
_httpContextAccessor = httpContextAccessor;
|
||||||
_options = options;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <inheritdoc />
|
/// <inheritdoc />
|
||||||
@ -153,7 +144,7 @@ namespace Kyoo.Core.Api
|
|||||||
string type = target is ICustomTypeDescriptor descriptor
|
string type = target is ICustomTypeDescriptor descriptor
|
||||||
? descriptor.GetClassName()
|
? descriptor.GetClassName()
|
||||||
: target.GetType().Name;
|
: target.GetType().Name;
|
||||||
return new Uri($"/api/{type}/{slug}/{Images.ImageName[_imageIndex]}".ToLowerInvariant())
|
return new Uri($"/{type}/{slug}/{Images.ImageName[_imageIndex]}".ToLowerInvariant())
|
||||||
.ToString();
|
.ToString();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -34,8 +34,8 @@ namespace Kyoo.Core.Api
|
|||||||
/// <summary>
|
/// <summary>
|
||||||
/// Information about one or multiple <see cref="Genre"/>.
|
/// Information about one or multiple <see cref="Genre"/>.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
[Route("api/genres")]
|
[Route("genres")]
|
||||||
[Route("api/genre", Order = AlternativeRoute)]
|
[Route("genre", Order = AlternativeRoute)]
|
||||||
[ApiController]
|
[ApiController]
|
||||||
[PartialPermission(nameof(Genre))]
|
[PartialPermission(nameof(Genre))]
|
||||||
[ApiDefinition("Genres", Group = MetadataGroup)]
|
[ApiDefinition("Genres", Group = MetadataGroup)]
|
||||||
|
@ -30,8 +30,8 @@ namespace Kyoo.Core.Api
|
|||||||
/// Providers are links to external websites or database.
|
/// Providers are links to external websites or database.
|
||||||
/// They are mostly linked to plugins that provide metadata from those websites.
|
/// They are mostly linked to plugins that provide metadata from those websites.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
[Route("api/providers")]
|
[Route("providers")]
|
||||||
[Route("api/provider", Order = AlternativeRoute)]
|
[Route("provider", Order = AlternativeRoute)]
|
||||||
[ApiController]
|
[ApiController]
|
||||||
[ResourceView]
|
[ResourceView]
|
||||||
[PartialPermission(nameof(Provider))]
|
[PartialPermission(nameof(Provider))]
|
||||||
|
@ -35,8 +35,8 @@ namespace Kyoo.Core.Api
|
|||||||
/// <summary>
|
/// <summary>
|
||||||
/// Information about one or multiple staff member.
|
/// Information about one or multiple staff member.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
[Route("api/staff")]
|
[Route("staff")]
|
||||||
[Route("api/people", Order = AlternativeRoute)]
|
[Route("people", Order = AlternativeRoute)]
|
||||||
[ApiController]
|
[ApiController]
|
||||||
[ResourceView]
|
[ResourceView]
|
||||||
[PartialPermission(nameof(People))]
|
[PartialPermission(nameof(People))]
|
||||||
|
@ -34,8 +34,8 @@ namespace Kyoo.Core.Api
|
|||||||
/// <summary>
|
/// <summary>
|
||||||
/// Information about one or multiple <see cref="Studio"/>.
|
/// Information about one or multiple <see cref="Studio"/>.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
[Route("api/studios")]
|
[Route("studios")]
|
||||||
[Route("api/studio", Order = AlternativeRoute)]
|
[Route("studio", Order = AlternativeRoute)]
|
||||||
[ApiController]
|
[ApiController]
|
||||||
[PartialPermission(nameof(Show))]
|
[PartialPermission(nameof(Show))]
|
||||||
[ApiDefinition("Studios", Group = MetadataGroup)]
|
[ApiDefinition("Studios", Group = MetadataGroup)]
|
||||||
|
@ -34,8 +34,8 @@ namespace Kyoo.Core.Api
|
|||||||
/// <summary>
|
/// <summary>
|
||||||
/// Information about one or multiple <see cref="Collection"/>.
|
/// Information about one or multiple <see cref="Collection"/>.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
[Route("api/collections")]
|
[Route("collections")]
|
||||||
[Route("api/collection", Order = AlternativeRoute)]
|
[Route("collection", Order = AlternativeRoute)]
|
||||||
[ApiController]
|
[ApiController]
|
||||||
[PartialPermission(nameof(Collection))]
|
[PartialPermission(nameof(Collection))]
|
||||||
[ApiDefinition("Collections", Group = ResourcesGroup)]
|
[ApiDefinition("Collections", Group = ResourcesGroup)]
|
||||||
|
@ -34,8 +34,8 @@ namespace Kyoo.Core.Api
|
|||||||
/// <summary>
|
/// <summary>
|
||||||
/// Information about one or multiple <see cref="Episode"/>.
|
/// Information about one or multiple <see cref="Episode"/>.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
[Route("api/episodes")]
|
[Route("episodes")]
|
||||||
[Route("api/episode", Order = AlternativeRoute)]
|
[Route("episode", Order = AlternativeRoute)]
|
||||||
[ApiController]
|
[ApiController]
|
||||||
[ResourceView]
|
[ResourceView]
|
||||||
[PartialPermission(nameof(Episode))]
|
[PartialPermission(nameof(Episode))]
|
||||||
|
@ -36,8 +36,8 @@ namespace Kyoo.Core.Api
|
|||||||
/// <summary>
|
/// <summary>
|
||||||
/// Information about one or multiple <see cref="Library"/>.
|
/// Information about one or multiple <see cref="Library"/>.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
[Route("api/libraries")]
|
[Route("libraries")]
|
||||||
[Route("api/library", Order = AlternativeRoute)]
|
[Route("library", Order = AlternativeRoute)]
|
||||||
[ApiController]
|
[ApiController]
|
||||||
[ResourceView]
|
[ResourceView]
|
||||||
[PartialPermission(nameof(Library), Group = Group.Admin)]
|
[PartialPermission(nameof(Library), Group = Group.Admin)]
|
||||||
|
@ -34,8 +34,8 @@ namespace Kyoo.Core.Api
|
|||||||
/// Endpoint for items that are not part of a specific library.
|
/// Endpoint for items that are not part of a specific library.
|
||||||
/// An item can ether represent a collection or a show.
|
/// An item can ether represent a collection or a show.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
[Route("api/items")]
|
[Route("items")]
|
||||||
[Route("api/item", Order = AlternativeRoute)]
|
[Route("item", Order = AlternativeRoute)]
|
||||||
[ApiController]
|
[ApiController]
|
||||||
[ResourceView]
|
[ResourceView]
|
||||||
[PartialPermission(nameof(LibraryItem))]
|
[PartialPermission(nameof(LibraryItem))]
|
||||||
|
@ -32,7 +32,7 @@ namespace Kyoo.Core.Api
|
|||||||
/// An endpoint to search for every resources of kyoo. Searching for only a specific type of resource
|
/// An endpoint to search for every resources of kyoo. Searching for only a specific type of resource
|
||||||
/// is available on the said endpoint.
|
/// is available on the said endpoint.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
[Route("api/search/{query}")]
|
[Route("search/{query}")]
|
||||||
[ApiController]
|
[ApiController]
|
||||||
[ResourceView]
|
[ResourceView]
|
||||||
[ApiDefinition("Search", Group = ResourcesGroup)]
|
[ApiDefinition("Search", Group = ResourcesGroup)]
|
||||||
|
@ -34,8 +34,8 @@ namespace Kyoo.Core.Api
|
|||||||
/// <summary>
|
/// <summary>
|
||||||
/// Information about one or multiple <see cref="Season"/>.
|
/// Information about one or multiple <see cref="Season"/>.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
[Route("api/seasons")]
|
[Route("seasons")]
|
||||||
[Route("api/season", Order = AlternativeRoute)]
|
[Route("season", Order = AlternativeRoute)]
|
||||||
[ApiController]
|
[ApiController]
|
||||||
[PartialPermission(nameof(Season))]
|
[PartialPermission(nameof(Season))]
|
||||||
[ApiDefinition("Seasons", Group = ResourcesGroup)]
|
[ApiDefinition("Seasons", Group = ResourcesGroup)]
|
||||||
|
@ -36,10 +36,10 @@ namespace Kyoo.Core.Api
|
|||||||
/// <summary>
|
/// <summary>
|
||||||
/// Information about one or multiple <see cref="Show"/>.
|
/// Information about one or multiple <see cref="Show"/>.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
[Route("api/shows")]
|
[Route("shows")]
|
||||||
[Route("api/show", Order = AlternativeRoute)]
|
[Route("show", Order = AlternativeRoute)]
|
||||||
[Route("api/movie", Order = AlternativeRoute)]
|
[Route("movie", Order = AlternativeRoute)]
|
||||||
[Route("api/movies", Order = AlternativeRoute)]
|
[Route("movies", Order = AlternativeRoute)]
|
||||||
[ApiController]
|
[ApiController]
|
||||||
[PartialPermission(nameof(Show))]
|
[PartialPermission(nameof(Show))]
|
||||||
[ApiDefinition("Shows", Group = ResourcesGroup)]
|
[ApiDefinition("Shows", Group = ResourcesGroup)]
|
||||||
|
@ -32,8 +32,8 @@ namespace Kyoo.Core.Api
|
|||||||
/// Information about one or multiple <see cref="Track"/>.
|
/// Information about one or multiple <see cref="Track"/>.
|
||||||
/// A track contain metadata about a video, an audio or a subtitles.
|
/// A track contain metadata about a video, an audio or a subtitles.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
[Route("api/tracks")]
|
[Route("tracks")]
|
||||||
[Route("api/track", Order = AlternativeRoute)]
|
[Route("track", Order = AlternativeRoute)]
|
||||||
[ApiController]
|
[ApiController]
|
||||||
[ResourceView]
|
[ResourceView]
|
||||||
[PartialPermission(nameof(Track))]
|
[PartialPermission(nameof(Track))]
|
||||||
|
@ -34,8 +34,8 @@ namespace Kyoo.Core.Api
|
|||||||
/// It contains streams (video, audio, subtitles) information, chapters, next and previous episodes and a bit of
|
/// It contains streams (video, audio, subtitles) information, chapters, next and previous episodes and a bit of
|
||||||
/// information of the show.
|
/// information of the show.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
[Route("api/watch")]
|
[Route("watch")]
|
||||||
[Route("api/watchitem", Order = AlternativeRoute)]
|
[Route("watchitem", Order = AlternativeRoute)]
|
||||||
[ApiController]
|
[ApiController]
|
||||||
[ApiDefinition("Watch Items", Group = WatchGroup)]
|
[ApiDefinition("Watch Items", Group = WatchGroup)]
|
||||||
public class WatchApi : ControllerBase
|
public class WatchApi : ControllerBase
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
*** Settings ***
|
*** Settings ***
|
||||||
Documentation Common things to handle rest requests
|
Documentation Common things to handle rest requests
|
||||||
|
|
||||||
Library REST http://localhost:5000/api
|
Library REST http://localhost:5000
|
||||||
|
Loading…
x
Reference in New Issue
Block a user