Merge pull request #21 from usbharu/feature/openapi

Feature/openapi

src/main/kotlin/dev/usbharu/hideout/Application.kt

@@ -78,6 +78,7 @@ fun Application.parent() {
                 install(httpSignaturePlugin) {
                     keyMap = KtorKeyMap(get())
                 }
+                expectSuccess = true
             }
         }
         single<IdGenerateService> { TwitterSnowflakeIdGenerateService }

src/main/kotlin/dev/usbharu/hideout/domain/model/ap/Emoji.kt

@@ -0,0 +1,42 @@
+package dev.usbharu.hideout.domain.model.ap
+
+open class Emoji : Object {
+    var updated: String? = null
+    var icon: Image? = null
+
+    protected constructor() : super()
+    constructor(
+        type: List<String>,
+        name: String?,
+        actor: String?,
+        id: String?,
+        updated: String?,
+        icon: Image?
+    ) : super(
+        type = add(type, "Emoji"),
+        name = name,
+        actor = actor,
+        id = id
+    ) {
+        this.updated = updated
+        this.icon = icon
+    }
+
+    override fun equals(other: Any?): Boolean {
+        if (this === other) return true
+        if (other !is Emoji) return false
+        if (!super.equals(other)) return false
+
+        if (updated != other.updated) return false
+        return icon == other.icon
+    }
+
+    override fun hashCode(): Int {
+        var result = super.hashCode()
+        result = 31 * result + (updated?.hashCode() ?: 0)
+        result = 31 * result + (icon?.hashCode() ?: 0)
+        return result
+    }
+
+    override fun toString(): String = "Emoji(updated=$updated, icon=$icon) ${super.toString()}"
+}

src/main/kotlin/dev/usbharu/hideout/domain/model/ap/Like.kt

@@ -0,0 +1,51 @@
+package dev.usbharu.hideout.domain.model.ap
+
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize
+
+open class Like : Object {
+    var `object`: String? = null
+    var content: String? = null
+
+    @JsonDeserialize(contentUsing = ObjectDeserializer::class)
+    var tag: List<Object> = emptyList()
+
+    protected constructor() : super()
+    constructor(
+        type: List<String>,
+        name: String?,
+        actor: String?,
+        id: String?,
+        `object`: String?,
+        content: String?,
+        tag: List<Object>
+    ) : super(
+        type = add(type, "Like"),
+        name = name,
+        actor = actor,
+        id = id
+    ) {
+        this.`object` = `object`
+        this.content = content
+        this.tag = tag
+    }
+
+    override fun equals(other: Any?): Boolean {
+        if (this === other) return true
+        if (other !is Like) return false
+        if (!super.equals(other)) return false
+
+        if (`object` != other.`object`) return false
+        if (content != other.content) return false
+        return tag == other.tag
+    }
+
+    override fun hashCode(): Int {
+        var result = super.hashCode()
+        result = 31 * result + (`object`?.hashCode() ?: 0)
+        result = 31 * result + (content?.hashCode() ?: 0)
+        result = 31 * result + tag.hashCode()
+        return result
+    }
+
+    override fun toString(): String = "Like(`object`=$`object`, content=$content, tag=$tag) ${super.toString()}"
+}

src/main/kotlin/dev/usbharu/hideout/domain/model/ap/ObjectDeserializer.kt

@@ -4,7 +4,7 @@ import com.fasterxml.jackson.core.JsonParser
 import com.fasterxml.jackson.databind.DeserializationContext
 import com.fasterxml.jackson.databind.JsonDeserializer
 import com.fasterxml.jackson.databind.JsonNode
-import dev.usbharu.hideout.service.activitypub.ActivityVocabulary
+import dev.usbharu.hideout.service.activitypub.ExtendedActivityVocabulary
 
 class ObjectDeserializer : JsonDeserializer<Object>() {
     override fun deserialize(p: JsonParser?, ctxt: DeserializationContext?): Object {
@@ -22,28 +22,78 @@ class ObjectDeserializer : JsonDeserializer<Object>() {
             val type = treeNode["type"]
             val activityType = if (type.isArray) {
                 type.firstNotNullOf { jsonNode: JsonNode ->
-                    ActivityVocabulary.values().firstOrNull { it.name.equals(jsonNode.asText(), true) }
+                    ExtendedActivityVocabulary.values().firstOrNull { it.name.equals(jsonNode.asText(), true) }
                 }
             } else if (type.isValueNode) {
-                ActivityVocabulary.values().first { it.name.equals(type.asText(), true) }
+                ExtendedActivityVocabulary.values().first { it.name.equals(type.asText(), true) }
             } else {
                 TODO()
             }
 
             return when (activityType) {
-                ActivityVocabulary.Follow -> {
+                ExtendedActivityVocabulary.Follow -> {
                     val readValue = p.codec.treeToValue(treeNode, Follow::class.java)
                     println(readValue)
                     readValue
                 }
 
-                ActivityVocabulary.Note -> {
+                ExtendedActivityVocabulary.Note -> {
                     p.codec.treeToValue(treeNode, Note::class.java)
                 }
 
-                else -> {
-                    TODO()
-                }
+                ExtendedActivityVocabulary.Object -> p.codec.treeToValue(treeNode, Object::class.java)
+                ExtendedActivityVocabulary.Link -> TODO()
+                ExtendedActivityVocabulary.Activity -> TODO()
+                ExtendedActivityVocabulary.IntransitiveActivity -> TODO()
+                ExtendedActivityVocabulary.Collection -> TODO()
+                ExtendedActivityVocabulary.OrderedCollection -> TODO()
+                ExtendedActivityVocabulary.CollectionPage -> TODO()
+                ExtendedActivityVocabulary.OrderedCollectionPage -> TODO()
+                ExtendedActivityVocabulary.Accept -> p.codec.treeToValue(treeNode, Accept::class.java)
+                ExtendedActivityVocabulary.Add -> TODO()
+                ExtendedActivityVocabulary.Announce -> TODO()
+                ExtendedActivityVocabulary.Arrive -> TODO()
+                ExtendedActivityVocabulary.Block -> TODO()
+                ExtendedActivityVocabulary.Create -> p.codec.treeToValue(treeNode, Create::class.java)
+                ExtendedActivityVocabulary.Delete -> TODO()
+                ExtendedActivityVocabulary.Dislike -> TODO()
+                ExtendedActivityVocabulary.Flag -> TODO()
+                ExtendedActivityVocabulary.Ignore -> TODO()
+                ExtendedActivityVocabulary.Invite -> TODO()
+                ExtendedActivityVocabulary.Join -> TODO()
+                ExtendedActivityVocabulary.Leave -> TODO()
+                ExtendedActivityVocabulary.Like -> p.codec.treeToValue(treeNode, Like::class.java)
+                ExtendedActivityVocabulary.Listen -> TODO()
+                ExtendedActivityVocabulary.Move -> TODO()
+                ExtendedActivityVocabulary.Offer -> TODO()
+                ExtendedActivityVocabulary.Question -> TODO()
+                ExtendedActivityVocabulary.Reject -> TODO()
+                ExtendedActivityVocabulary.Read -> TODO()
+                ExtendedActivityVocabulary.Remove -> TODO()
+                ExtendedActivityVocabulary.TentativeReject -> TODO()
+                ExtendedActivityVocabulary.TentativeAccept -> TODO()
+                ExtendedActivityVocabulary.Travel -> TODO()
+                ExtendedActivityVocabulary.Undo -> p.codec.treeToValue(treeNode, Undo::class.java)
+                ExtendedActivityVocabulary.Update -> TODO()
+                ExtendedActivityVocabulary.View -> TODO()
+                ExtendedActivityVocabulary.Application -> TODO()
+                ExtendedActivityVocabulary.Group -> TODO()
+                ExtendedActivityVocabulary.Organization -> TODO()
+                ExtendedActivityVocabulary.Person -> p.codec.treeToValue(treeNode, Person::class.java)
+                ExtendedActivityVocabulary.Service -> TODO()
+                ExtendedActivityVocabulary.Article -> TODO()
+                ExtendedActivityVocabulary.Audio -> TODO()
+                ExtendedActivityVocabulary.Document -> TODO()
+                ExtendedActivityVocabulary.Event -> TODO()
+                ExtendedActivityVocabulary.Image -> p.codec.treeToValue(treeNode, Image::class.java)
+                ExtendedActivityVocabulary.Page -> TODO()
+                ExtendedActivityVocabulary.Place -> TODO()
+                ExtendedActivityVocabulary.Profile -> TODO()
+                ExtendedActivityVocabulary.Relationship -> TODO()
+                ExtendedActivityVocabulary.Tombstone -> TODO()
+                ExtendedActivityVocabulary.Video -> TODO()
+                ExtendedActivityVocabulary.Mention -> TODO()
+                ExtendedActivityVocabulary.Emoji -> p.codec.treeToValue(treeNode, Emoji::class.java)
             }
         } else {
             TODO()

src/main/kotlin/dev/usbharu/hideout/domain/model/hideout/entity/Reaction.kt

@@ -0,0 +1,3 @@
+package dev.usbharu.hideout.domain.model.hideout.entity
+
+data class Reaction(val id: Long, val emojiId: Long, val postId: Long, val userId: Long)

src/main/kotlin/dev/usbharu/hideout/plugins/ActivityPub.kt

@@ -44,12 +44,14 @@ suspend fun HttpClient.postAp(urlString: String, username: String, jsonLd: JsonL
     }
 }
 
-suspend fun HttpClient.getAp(urlString: String, username: String): HttpResponse {
+suspend fun HttpClient.getAp(urlString: String, username: String?): HttpResponse {
     return this.get(urlString) {
         header("Accept", ContentType.Application.Activity)
+        username?.let {
             header("Signature", "keyId=\"$username\",algorithm=\"rsa-sha256\",headers=\"(request-target) host date\"")
         }
     }
+}
 
 class HttpSignaturePluginConfig {
     lateinit var keyMap: KeyMap

src/main/kotlin/dev/usbharu/hideout/repository/PostRepositoryImpl.kt

@@ -63,7 +63,9 @@ class PostRepositoryImpl(database: Database, private val idGenerateService: IdGe
     }
 
     override suspend fun findOneById(id: Long, userId: Long?): Post? {
-        TODO("Not yet implemented")
+        return query {
+            Posts.select { Posts.id eq id }.singleOrNull()?.toPost()
+        }
     }
 
     override suspend fun findByUrl(url: String): Post? {

src/main/kotlin/dev/usbharu/hideout/repository/ReactionRepository.kt

@@ -0,0 +1,9 @@
+package dev.usbharu.hideout.repository
+
+import dev.usbharu.hideout.domain.model.hideout.entity.Reaction
+
+interface ReactionRepository {
+    suspend fun generateId(): Long
+    suspend fun save(reaction: Reaction): Reaction
+    suspend fun reactionAlreadyExist(postId: Long, userId: Long, emojiId: Long): Boolean
+}

src/main/kotlin/dev/usbharu/hideout/repository/ReactionRepositoryImpl.kt

@@ -0,0 +1,79 @@
+package dev.usbharu.hideout.repository
+
+import dev.usbharu.hideout.domain.model.hideout.entity.Reaction
+import dev.usbharu.hideout.service.core.IdGenerateService
+import kotlinx.coroutines.Dispatchers
+import org.jetbrains.exposed.dao.id.LongIdTable
+import org.jetbrains.exposed.sql.*
+import org.jetbrains.exposed.sql.transactions.experimental.newSuspendedTransaction
+import org.jetbrains.exposed.sql.transactions.transaction
+import org.koin.core.annotation.Single
+
+@Single
+class ReactionRepositoryImpl(
+    private val database: Database,
+    private val idGenerateService: IdGenerateService
+) : ReactionRepository {
+
+    init {
+        transaction(database) {
+            SchemaUtils.create(Reactions)
+            SchemaUtils.createMissingTablesAndColumns(Reactions)
+        }
+    }
+
+    @Suppress("InjectDispatcher")
+    suspend fun <T> query(block: suspend () -> T): T =
+        newSuspendedTransaction(Dispatchers.IO) { block() }
+
+    override suspend fun generateId(): Long = idGenerateService.generateId()
+
+    override suspend fun save(reaction: Reaction): Reaction {
+        query {
+            if (Reactions.select { Reactions.id eq reaction.id }.empty()) {
+                Reactions.insert {
+                    it[id] = reaction.id
+                    it[emojiId] = reaction.emojiId
+                    it[postId] = reaction.postId
+                    it[userId] = reaction.userId
+                }
+            } else {
+                Reactions.update({ Reactions.id eq reaction.id }) {
+                    it[emojiId] = reaction.emojiId
+                    it[postId] = reaction.postId
+                    it[userId] = reaction.userId
+                }
+            }
+        }
+        return reaction
+    }
+
+    override suspend fun reactionAlreadyExist(postId: Long, userId: Long, emojiId: Long): Boolean {
+        return query {
+            Reactions.select {
+                Reactions.postId.eq(postId).and(Reactions.userId.eq(userId)).and(
+                    Reactions.emojiId.eq(emojiId)
+                )
+            }.empty().not()
+        }
+    }
+}
+
+fun ResultRow.toReaction(): Reaction {
+    return Reaction(
+        this[Reactions.id].value,
+        this[Reactions.emojiId],
+        this[Reactions.postId],
+        this[Reactions.userId]
+    )
+}
+
+object Reactions : LongIdTable("reactions") {
+    val emojiId = long("emoji_id")
+    val postId = long("post_id").references(Posts.id)
+    val userId = long("user_id").references(Users.id)
+
+    init {
+        uniqueIndex(emojiId, postId, userId)
+    }
+}

src/main/kotlin/dev/usbharu/hideout/service/activitypub/ActivityPubLikeService.kt

@@ -0,0 +1,8 @@
+package dev.usbharu.hideout.service.activitypub
+
+import dev.usbharu.hideout.domain.model.ActivityPubResponse
+import dev.usbharu.hideout.domain.model.ap.Like
+
+interface ActivityPubLikeService {
+    suspend fun receiveLike(like: Like): ActivityPubResponse
+}

src/main/kotlin/dev/usbharu/hideout/service/activitypub/ActivityPubLikeServiceImpl.kt

@@ -0,0 +1,40 @@
+package dev.usbharu.hideout.service.activitypub
+
+import dev.usbharu.hideout.domain.model.ActivityPubResponse
+import dev.usbharu.hideout.domain.model.ActivityPubStringResponse
+import dev.usbharu.hideout.domain.model.ap.Like
+import dev.usbharu.hideout.exception.PostNotFoundException
+import dev.usbharu.hideout.exception.ap.IllegalActivityPubObjectException
+import dev.usbharu.hideout.repository.IPostRepository
+import dev.usbharu.hideout.service.reaction.IReactionService
+import dev.usbharu.hideout.service.user.IUserService
+import io.ktor.http.*
+import org.koin.core.annotation.Single
+
+@Single
+class ActivityPubLikeServiceImpl(
+    private val reactionService: IReactionService,
+    private val activityPubUserService: ActivityPubUserService,
+    private val userService: IUserService,
+    private val postService: IPostRepository,
+    private val activityPubNoteService: ActivityPubNoteService
+) : ActivityPubLikeService {
+    override suspend fun receiveLike(like: Like): ActivityPubResponse {
+        val actor = like.actor ?: throw IllegalActivityPubObjectException("actor is null")
+        val content = like.content ?: throw IllegalActivityPubObjectException("content is null")
+        like.`object` ?: throw IllegalActivityPubObjectException("object is null")
+        val person = activityPubUserService.fetchPerson(actor)
+        activityPubNoteService.fetchNote(like.`object`!!)
+
+        val user = userService.findByUrl(
+            person.url
+                ?: throw IllegalActivityPubObjectException("actor is not found")
+        )
+
+        val post = postService.findByUrl(like.`object`!!)
+            ?: throw PostNotFoundException("${like.`object`} was not found")
+
+        reactionService.receiveReaction(content, actor.substringAfter("://").substringBefore("/"), user.id, post.id)
+        return ActivityPubStringResponse(HttpStatusCode.OK, "")
+    }
+}

src/main/kotlin/dev/usbharu/hideout/service/activitypub/ActivityPubNoteServiceImpl.kt

@@ -14,7 +14,7 @@ import dev.usbharu.hideout.repository.IPostRepository
 import dev.usbharu.hideout.service.job.JobQueueParentService
 import dev.usbharu.hideout.service.user.IUserService
 import io.ktor.client.*
-import io.ktor.client.call.*
+import io.ktor.client.statement.*
 import kjob.core.job.JobProps
 import org.koin.core.annotation.Single
 import org.slf4j.LoggerFactory
@@ -76,9 +76,9 @@ class ActivityPubNoteServiceImpl(
         }
         val response = httpClient.getAp(
             url,
-                "$targetActor#pubkey"
+            targetActor?.let { "$targetActor#pubkey" }
         )
-        val note = response.body<Note>()
+        val note = Config.configData.objectMapper.readValue<Note>(response.bodyAsText())
         return note(note, targetActor, url)
     }
 

src/main/kotlin/dev/usbharu/hideout/service/activitypub/ActivityPubService.kt

@@ -100,3 +100,65 @@ enum class ActivityVocabulary {
     Video,
     Mention,
 }
+
+enum class ExtendedActivityVocabulary {
+    Object,
+    Link,
+    Activity,
+    IntransitiveActivity,
+    Collection,
+    OrderedCollection,
+    CollectionPage,
+    OrderedCollectionPage,
+    Accept,
+    Add,
+    Announce,
+    Arrive,
+    Block,
+    Create,
+    Delete,
+    Dislike,
+    Flag,
+    Follow,
+    Ignore,
+    Invite,
+    Join,
+    Leave,
+    Like,
+    Listen,
+    Move,
+    Offer,
+    Question,
+    Reject,
+    Read,
+    Remove,
+    TentativeReject,
+    TentativeAccept,
+    Travel,
+    Undo,
+    Update,
+    View,
+    Application,
+    Group,
+    Organization,
+    Person,
+    Service,
+    Article,
+    Audio,
+    Document,
+    Event,
+    Image,
+    Note,
+    Page,
+    Place,
+    Profile,
+    Relationship,
+    Tombstone,
+    Video,
+    Mention,
+    Emoji
+}
+
+enum class ExtendedVocabulary {
+    Emoji
+}

src/main/kotlin/dev/usbharu/hideout/service/activitypub/ActivityPubServiceImpl.kt

@@ -21,7 +21,8 @@ class ActivityPubServiceImpl(
     private val activityPubNoteService: ActivityPubNoteService,
     private val activityPubUndoService: ActivityPubUndoService,
     private val activityPubAcceptService: ActivityPubAcceptService,
-    private val activityPubCreateService: ActivityPubCreateService
+    private val activityPubCreateService: ActivityPubCreateService,
+    private val activityPubLikeService: ActivityPubLikeService
 ) : ActivityPubService {
 
     val logger: Logger = LoggerFactory.getLogger(this::class.java)
@@ -53,6 +54,7 @@ class ActivityPubServiceImpl(
             )
 
             ActivityType.Create -> activityPubCreateService.receiveCreate(configData.objectMapper.readValue(json))
+            ActivityType.Like -> activityPubLikeService.receiveLike(configData.objectMapper.readValue(json))
             ActivityType.Undo -> activityPubUndoService.receiveUndo(configData.objectMapper.readValue(json))
 
             else -> {

src/main/kotlin/dev/usbharu/hideout/service/activitypub/ActivityPubUserServiceImpl.kt

@@ -93,7 +93,7 @@ class ActivityPubUserServiceImpl(
                 RemoteUserCreateDto(
                     name = person.preferredUsername
                         ?: throw IllegalActivityPubObjectException("preferredUsername is null"),
-                    domain = url.substringAfter("://").substringBeforeLast("/"),
+                    domain = url.substringAfter("://").substringBefore("/"),
                     screenName = (person.name ?: person.preferredUsername)
                         ?: throw IllegalActivityPubObjectException("preferredUsername is null"),
                     description = person.summary.orEmpty(),

src/main/kotlin/dev/usbharu/hideout/service/api/IPostApiService.kt

@@ -3,6 +3,7 @@ package dev.usbharu.hideout.service.api
 import dev.usbharu.hideout.domain.model.hideout.entity.Post
 import java.time.Instant
 
+@Suppress("LongParameterList")
 interface IPostApiService {
     suspend fun createPost(postForm: dev.usbharu.hideout.domain.model.hideout.form.Post, userId: Long): Post
     suspend fun getById(id: Long, userId: Long?): Post

src/main/kotlin/dev/usbharu/hideout/service/api/PostApiServiceImpl.kt

@@ -56,15 +56,15 @@ class PostApiServiceImpl(
         return if (idOrNull == null) {
             val acct = AcctUtil.parse(nameOrId)
             postRepository.findByUserNameAndDomain(
-                    acct.username,
-                    acct.domain
+                username = acct.username,
+                s = acct.domain
                     ?: Config.configData.domain,
-                    since,
-                    until,
-                    minId,
-                    maxId,
-                    limit,
-                    userId
+                since = since,
+                until = until,
+                minId = minId,
+                maxId = maxId,
+                limit = limit,
+                userId = userId
             )
         } else {
             postRepository.findByUserId(idOrNull, since, until, minId, maxId, limit, userId)

src/main/kotlin/dev/usbharu/hideout/service/reaction/IReactionService.kt

@@ -0,0 +1,5 @@
+package dev.usbharu.hideout.service.reaction
+
+interface IReactionService {
+    suspend fun receiveReaction(name: String, domain: String, userId: Long, postId: Long)
+}

src/main/kotlin/dev/usbharu/hideout/service/reaction/ReactionServiceImpl.kt

@@ -0,0 +1,16 @@
+package dev.usbharu.hideout.service.reaction
+
+import dev.usbharu.hideout.domain.model.hideout.entity.Reaction
+import dev.usbharu.hideout.repository.ReactionRepository
+import org.koin.core.annotation.Single
+
+@Single
+class ReactionServiceImpl(private val reactionRepository: ReactionRepository) : IReactionService {
+    override suspend fun receiveReaction(name: String, domain: String, userId: Long, postId: Long) {
+        if (reactionRepository.reactionAlreadyExist(postId, userId, 0).not()) {
+            reactionRepository.save(
+                Reaction(reactionRepository.generateId(), 0, postId, userId)
+            )
+        }
+    }
+}

src/main/resources/openapi/api.yaml

@@ -0,0 +1,335 @@
+openapi: 3.0.3
+info:
+  title: Hideout API
+  description: Hideout API
+  version: 1.0.0
+servers:
+  - url: 'https://test-hideout.usbharu.dev/api/internal/v1'
+paths:
+  /posts:
+    get:
+      summary: 権限に応じて投稿一覧を返す
+      security:
+        - { }
+        - BearerAuth: [ ]
+      responses:
+        200:
+          description: 成功
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/Post"
+        401:
+          $ref: "#/components/responses/Unauthorized"
+        403:
+          $ref: "#/components/responses/Forbidden"
+        429:
+          $ref: "#/components/responses/TooManyRequests"
+    post:
+      summary: 投稿する
+      security:
+        - BearerAuth: [ ]
+      requestBody:
+        description: 投稿する内容
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/Post"
+      responses:
+        200:
+          description: 成功
+          headers:
+            Location:
+              description: 作成した投稿のURL
+              schema:
+                type: string
+                format: uri
+        401:
+          $ref: "#/components/responses/Unauthorized"
+        429:
+          $ref: "#/components/responses/TooManyRequests"
+  /posts/{postId}:
+    get:
+      summary: 権限に応じてIDの投稿を返す
+      security:
+        - { }
+        - BearerAuth: [ ]
+      parameters:
+        - $ref: "#/components/parameters/postId"
+      responses:
+        200:
+          description: 成功
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Post"
+        401:
+          $ref: "#/components/responses/Unauthorized"
+        403:
+          $ref: "#/components/responses/Forbidden"
+        404:
+          $ref: "#/components/responses/NotFoundOrForbidden"
+        429:
+          $ref: "#/components/responses/TooManyRequests"
+  /users/{userName}/posts:
+    get:
+      summary: 権限に応じてユーザーの投稿一覧を返す
+      security:
+        - { }
+        - BearerAuth: [ ]
+      parameters:
+        - $ref: "#/components/parameters/userName"
+      responses:
+        200:
+          description: 成功
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/Post"
+        401:
+          $ref: "#/components/responses/Unauthorized"
+        403:
+          $ref: "#/components/responses/Forbidden"
+        429:
+          $ref: "#/components/responses/TooManyRequests"
+
+  /users/{userName}/posts/{postId}:
+    get:
+      summary: 権限に応じてIDの投稿を返す
+      description: userNameが間違っていても取得できます。
+      security:
+        - { }
+        - BearerAuth: [ ]
+      parameters:
+        - $ref: "#/components/parameters/userName"
+        - $ref: "#/components/parameters/postId"
+      responses:
+        200:
+          description: 成功
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Post"
+        401:
+          $ref: "#/components/responses/Unauthorized"
+        403:
+          $ref: "#/components/responses/Forbidden"
+        404:
+          $ref: "#/components/responses/NotFoundOrForbidden"
+        429:
+          $ref: "#/components/responses/TooManyRequests"
+
+  /users:
+    get:
+      summary: ユーザー一覧を返す
+      security:
+        - { }
+      responses:
+        200:
+          description: 成功
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/User"
+
+    post:
+      summary: ユーザーを作成する
+      security:
+        - { }
+      requestBody:
+        description: 作成するユーザーの詳細
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                username:
+                  type: string
+                password:
+                  type: string
+      responses:
+        201:
+          description: ユーザーが作成された
+          headers:
+            Location:
+              description: 作成されたユーザーのURL
+              schema:
+                type: string
+                format: url
+        400:
+          description: ユーザー名が既に仕様されている。またはリクエストが異常
+
+  /users/{userName}:
+    get:
+      summary: ユーザーの詳細を返す
+      security:
+        - { }
+        - BearerAuth: [ ]
+      parameters:
+        - $ref: "#/components/parameters/userName"
+      responses:
+        200:
+          description: 成功
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/User"
+        404:
+          $ref: "#/components/responses/NotFound"
+
+  /users/{userName}/followers:
+    get:
+      summary: ユーザーのフォロワー一覧を返す
+      parameters:
+        - $ref: "#/components/parameters/userName"
+      responses:
+        200:
+          description: 成功
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/User"
+    post:
+      summary: ユーザーをフォローする
+      security:
+        - BearerAuth: [ ]
+      parameters:
+        - $ref: "#/components/parameters/userName"
+      responses:
+        200:
+          description: 成功
+        202:
+          description: 受け付けられたが完了していない
+        401:
+          $ref: "#/components/responses/Unauthorized"
+        404:
+          $ref: "#/components/responses/NotFound"
+
+  /users/{userName}/following:
+    get:
+      summary: ユーザーのフォロイー一覧を返す
+      parameters:
+        - $ref: "#/components/parameters/userName"
+      responses:
+        200:
+          description: 成功
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/User"
+
+components:
+  responses:
+    Unauthorized:
+      description: トークンが無効
+    Forbidden:
+      description: 権限がない
+    NotFoundOrForbidden:
+      description: 存在しないか権限がない
+    NotFound:
+      description: 存在しない
+    TooManyRequests:
+      description: レートリミット
+
+  parameters:
+    postId:
+      name: postId
+      in: path
+      description: 投稿ID
+      required: true
+      schema:
+        type: integer
+        format: int64
+    userName:
+      name: userName
+      in: path
+      description: ユーザーIDまたはAcctなど @name@domain name@domain name
+      required: true
+      schema:
+        type: string
+
+  schemas:
+    User:
+      type: object
+      properties:
+        id:
+          type: number
+          format: int64
+          readOnly: true
+        name:
+          type: string
+        domain:
+          type: string
+          readOnly: true
+        screenName:
+          type: string
+        description:
+          type: string
+        url:
+          type: string
+          readOnly: true
+        createdAt:
+          type: number
+          readOnly: true
+    Post:
+      type: object
+      properties:
+        id:
+          type: integer
+          format: int64
+          readOnly: true
+        userId:
+          type: integer
+          format: int64
+          readOnly: true
+        overview:
+          type: string
+        text:
+          type: string
+        createdAt:
+          type: integer
+          format: int64
+          readOnly: true
+        visibility:
+          type: string
+          enum:
+            - public
+            - unlisted
+            - followers
+            - direct
+        url:
+          type: string
+          format: uri
+          readOnly: true
+        repostId:
+          type: integer
+          format: int64
+          readOnly: true
+        replyId:
+          type: integer
+          format: int64
+          readOnly: true
+        sensitive:
+          type: boolean
+        apId:
+          type: string
+          format: url
+          readOnly: true
+
+
+  securitySchemes:
+    BearerAuth:
+      type: http
+      scheme: bearer