PlainApp
API 参考

共享

管理分享及虚拟路径映射。分享内容通过现有 guest_graphql 浏览,文件通过 /fs 访问,保存文件使用通用下载接口。

类型定义

graphql
type Mutation {
  createShare(input: ShareInput!): Share!
  deleteShare(id: ID!): Boolean!
  updateShare(id: ID!, input: ShareInput!): Share!
}

type Query {
  share(id: ID!): Share
  shares: [Share!]!
}

scalar Instant

type Share {
	id: ID!
	name: String!
	password: String!
	expiresAt: Instant
	readOnly: Boolean!
	data: [SharePath!]!
	url: String!
}

input ShareInput {
	name: String!
	password: String!
	expiresAt: Instant
	readOnly: Boolean!
	data: [SharePathInput!]!
}

type SharePath {
	virtualPath: String!
	realPath: String!
	isDir: Boolean!
}

input SharePathInput {
	virtualPath: String!
	realPath: String!
	isDir: Boolean!
}

操作

mutation

createShare

创建分享,返回可直接使用的分享地址。

graphql
mutation createShare($input: ShareInput!) {
  createShare(input: $input) { id name password expiresAt readOnly url }
}
mutation

deleteShare

删除分享,并撤销通过该分享的访问权限。

graphql
mutation deleteShare($id: ID!) {
  deleteShare(id: $id)
}
mutation

updateShare

完整替换分享名称、密码、到期时间、只读设置和路径映射。

graphql
mutation updateShare($id: ID!, $input: ShareInput!) {
  updateShare(id: $id, input: $input) { id name password expiresAt readOnly url }
}
query

share

读取一个分享及其路径映射和地址;不存在时返回 null。

graphql
query share($id: ID!) {
  share(id: $id) { id name password expiresAt readOnly url }
}
query

shares

列出已保存的分享,包含可继续编辑的过期分享。

graphql
query shares {
  shares { id name password expiresAt readOnly url }
}